Skip to main content
GET
Preview Remittance Request Endpoint

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

bank_transaction_id
string
required

The bank transaction ID to preview a remittance request for.

partner_id
string
required

The partner ID to preview with.

Response

Successful Response

Preview of what would happen if a remittance request were sent.

can_send
boolean
required
recipient_email
string | null
required
partner_name
string | null
required
sender_email
string | null
required
preview_subject
string | null
required
preview_body
string | null
required
skip_reason
string | null
required