Create a payment

post

https://api.stage.payouts.com/payments/create

Required MFA token action for this API:

CREATE_PAYMENT

Required permissions for this API:

WRITE:TRANSFERS

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

beneficiary

object

Details for the beneficiary in the payment request. If beneficiary_id provided in the payment request then beneficiary should be empty.

beneficiaryId

string

Beneficiary_id of the beneficiary contact used to create this payment.

clientData

string

Free text field available to you; can be populated with any additional identifiers that may be required for the payment.

feePaidBy

string

enum

Denotes whether PAYER/BENEFICIARY will be liable for the payment fees, and it affects the actual amount the beneficiary receives.

Allowed:

applicationFeeOptions

array of objects

The application fee options applied to the transaction.

applicationFeeOptions

metadata

object

A set of key-value pairs for storing your own data together with the payment.

payer

object

required

Details of the payer

payerId

string

Payer_id of the payer contact used to create this payment.

quoteId

string

Quote id from a previously created lockfx quote.

reason

string

required

Reason for the payment instruction.

reference

string

required

Bank payment reference to be shown on beneficiary's bank transaction history.

remarks

string

required

Additional information about this transfer, which will not be passed to the beneficiary.

requestId

string

required

Client-generated idempotency key. Must be unique per request attempt. Conversion requests with the same request_id will be rejected. Parameter supports a maximum of 64 characters.

sourceAmount

number

Amount to be received.

sourceCurrency

string

required

Copied from the request if specified.

swiftChargeOption

string

(For SWIFT payments only), specify who should bear SWIFT charges, either SHARED (default) or PAYER.

transferAmount

number

required

Amount to be paid.

transferCurrency

string

required

Currency the transfer should be made in (3-letter ISO-4217 code).

transferDate

string

Date when transfer should be made

transferMethod

string

required

Transfer method, i.e. SWIFT, LOCAL

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201A response indicating that a payment is created.

401A response indicating that the provided api token is invalid or has already expired