Create Collection

This API endpoint allows you to create a Collection payment in real-time.

Request

FieldRequiredTypeDescription
emailyesstringCustomer email address
first_nameyesstringCustomer first name
last_nameyesstringCustomer last name
amountyesintegerPayment amount for collection in cents
expirynostringDatetime formatted in RFC3339
external_tagnostringUser defined searchable tag
currencyyesstring3 letter Currency Code
account_refnostringUser defined account reference (used in payment portal and for reporting)

Response

FieldValueDescription
idstring
statusstring
first_namestring
last_namestring
amountinteger
currencystring
emailstring
expirystring
account_refstring
external_tagstring
txn_idstring
txn_timestring
void_txn_idstring
void_txn_timestring
return_txn_idstring
return_txn_timestring
created_atstring
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
number
string
string
string
string
string
Response

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json