Initiate a Book (Transfer) Payment

Initiate a transfer payment request

SecurityoAuth2
Request
Request Body schema: application/json
required

Book Transfer [Transfer] Request Fields

externalReferenceId
required
string

Unique reference id from a system outside of finzly. The external reference id can be used by the finzly for the request tracing (if needed).

required
object (BookTransferSender)
required
object (BookTransferReceiver)
paymentAmount
required
number

Payment amount in USD you want to transfer.

paymentDate
required
string

Payment date in mm-dd-yyyy format.

channel
string

Channel associated with the payment

Responses
200

search results matching criteria

400

bad input parameter environment

401

Unauthorized

403

Forbidden

404

Not Found

405

bad input parameter environment

500

Internal server error

503

Service unavailable

default

return payment response

post/v3/payments/booktransfer
Request samples
application/json
{
  • "externalReferenceId": "Payment101",
  • "senderAccount": {
    },
  • "receiverAccount": {
    },
  • "paymentAmount": 100,
  • "paymentDate": "07-21-2022",
  • "channel": "API, TELLER etc."
}
Response samples
application/json
{
  • "status": "Success or Failure",
  • "code": "BOOKTRF001 etc.",
  • "message": "Failed to create a book transfer payment: <Reason>",
  • "data": {
    }
}