Step 2 - Accept a quote

Upon accepting a quotation, a payment will be initiated.

Create a Payment

The payment data structure must encompass all essential details required to execute the transaction, including information about the sender, the beneficiary, and the quotation. From now on, this structure will be referred to as "UserInfo".

circle-info

The UserInfo data structure is modeled after ISO 20200arrow-up-right.

The UserInfo structure is consistent and unique across all country destinations, yet the mandatory fields required and validations will vary for each country. You can get all details in this link UserInfo

Parameters to take into account

QuoteId

It is the quote ID you generated before; a payment needs to be associated with a quote.

ReferenceId

This is the idempotency ID of the payment, generated by your systems. It can be used to identify a payment with an ID that both parties understand.

UserInfo

Here, you will input the sender, beneficiary, and payment method information required to execute the transaction.

You can get a full description here:

UserInfochevron-right

WebhookUrl

This URL is used to post notifications about when the transaction is locked or when a lock is declined. It's not mandatory, but we would recommend using it. Alternatively, you can use this method: Step 4 - Get the payment status

API call

Accepts the quote.

post
chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : MoneyTransfer API
  • : Support API
Authorizations
OAuth2clientCredentialsRequired
Token URL:
OAuth2implicitRequired
Authorization URL:
Body
quoteIdstring · uuidOptional
referenceIdstringOptional
webHookUrlstringOptional
waitForLockbooleanOptional
Responses
chevron-right
201

Returns the newly created payment object with status CREATED

application/json
idstring · uuidOptional
typestring · enumOptionalPossible values:
createdAtstring · date-timeOptional
quoteIdstring · uuidOptional
payerIdinteger · int32Optional
debitAmountnumber · doubleOptional
debitCurrencystringOptional
fxRatenumber · doubleOptional
amountnumber · doubleOptional
currencystringOptional
collectMethodstring · enumOptionalPossible values:
referenceIdstringOptional
statusstring · enumOptionalPossible values:
subStatestring · enumOptionalPossible values:
lockDeclineReasonstringOptional
lockDeclineDescriptionstringOptional
reverseReasonstringOptional
payerPaymentCodestringOptional
transactionIdinteger · int32Optional
lockedAtstring · date-timeOptional
lockDeclinedAtstring · date-timeOptional
expiredAtstring · date-timeOptional
settledAtstring · date-timeOptional
forwardedAtstring · date-timeOptional
awaitingCollectionSincestring · date-timeOptional
completedAtstring · date-timeOptional
reversedAtstring · date-timeOptional
liquidityErrorbooleanOptional
invoiceUrlstringOptional
post
/api/Payments

Last updated