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 <= 200 characters

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).

paymentAmount
required
number

Payment amount in USD you want to transfer.

paymentDate
required
string

Payment date in mm-dd-yyyy format. This can be same date of Payment request or a future date. In case of a Recurring Payments, this shall be the date on which the 1st Standing Order will be executed. User may need to provide this as future date in case of a need to start the standing order in a future date.

paymentNotes
string [ 1 .. 250 ] characters

Payment notes provided by the payment originator.

channel
string

The channel name set by the payment origination system such as API, TELLER etc. This is an optional field and defaulted to API if it is not provided. The channel names should be defined in the Finzly system before it can be used in the API.

required
object (BookTransferSender)
required
object (BookTransferReceiver)
object (BookTransferAdditionalInfo)
object (PaymentRecurrence)

Set the payment recurrence based on the available options.

Responses
200

The payment has been created successfully.

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

405

bad input parameter environment

500

Internal server error

503

Service unavailable

post/v3/payments/booktransfer
Request samples
application/json
{
  • "externalReferenceId": "Payment101",
  • "paymentAmount": 100,
  • "paymentDate": "07-21-2022",
  • "paymentNotes": "Payment Notes",
  • "channel": "API",
  • "senderAccount": {
    },
  • "receiverAccount": {
    },
  • "additionalInfo": {
    },
  • "recurrence": {
    }
}
Response samples
application/json
{
  • "status": "Success",
  • "data": {
    }
}