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

The UserInfo data structure is modeled after ISO 20200.

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:

⭐UserInfo

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

Authorizations

oauth2-implicitoauth2-client-credentials

Body

application/json-patch+jsonapplication/jsonapplication/*+json

quoteIdstring · uuidOptional

referenceIdstringOptional

webHookUrlstringOptional

waitForLockbooleanOptional

Responses

201

Returns the newly created payment object with status CREATED

application/json

400

If the request body is not correct

401

Unauthorized

403

Forbidden

409

If the Quote was already Accepted

412

If the Quote is expired

post

HTTPcURLJavaScriptPython

POST /api/Payments HTTP/1.1
Host: 
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1308

{
  "quoteId": "123e4567-e89b-12d3-a456-426614174000",
  "referenceId": "text",
  "userInfo": {
    "Dbtr": {
      "StrdNm": {
        "FirstNm": "text",
        "LastNm": "text"
      },
      "PstlAdr": {
        "Ctry": "text",
        "CtrySubDvsn": "text",
        "TwnNm": "text",
        "AdrLine": "text",
        "PstCd": "text"
      },
      "Id": {
        "PrvtId": {
          "Othr": {
            "Id": "text",
            "Issr": "text",
            "SchmeNm": {
              "Cd": "ARNU",
              "Prtry": "text"
            }
          },
          "DtAndPlcOfBirth": {
            "BirthDt": "text",
            "CtryOfBirth": "text"
          }
        },
        "OrgId": {
          "Othr": {
            "Id": "text",
            "Issr": "text",
            "SchmeNm": {
              "Cd": "ARNU",
              "Prtry": "text"
            }
          }
        }
      },
      "CtctDtls": {
        "EmailAdr": "text",
        "PhneNb": "text",
        "Othr": "text"
      },
      "Nm": "text"
    },
    "Cdtr": {
      "StrdNm": {
        "FirstNm": "text",
        "LastNm": "text"
      },
      "PstlAdr": {
        "Ctry": "text",
        "CtrySubDvsn": "text",
        "TwnNm": "text",
        "AdrLine": "text",
        "PstCd": "text"
      },
      "Id": {
        "PrvtId": {
          "Othr": {
            "Id": "text",
            "Issr": "text",
            "SchmeNm": {
              "Cd": "ARNU",
              "Prtry": "text"
            }
          },
          "DtAndPlcOfBirth": {
            "BirthDt": "text",
            "CtryOfBirth": "text"
          }
        }
      },
      "CtctDtls": {
        "EmailAdr": "text",
        "PhneNb": "text",
        "Othr": "text"
      }
    },
    "CdtrAgt": {
      "FinInstnId": {
        "BICFI": "text"
      },
      "BrnchId": {
        "Id": "text"
      }
    },
    "CdtrAcct": {
      "Id": {
        "Othr": {
          "Id": "text"
        }
      },
      "Tp": {
        "Cd": "SVGS"
      }
    },
    "Purp": {
      "Prtry": "FAMILY_SUPPORT"
    },
    "InstForCdtrAgt": {
      "InstrInf": "text"
    },
    "PmtId": {
      "TxId": "text"
    }
  },
  "billingInfo": {
    "Ctry": "text",
    "Fx": {
      "Currency": "text",
      "Rate": 1,
      "Spread": 1
    },
    "NetAmount": 1,
    "Commission": {
      "Amount": 1,
      "Rate": 1
    },
    "Vat": {
      "Amount": 1,
      "Rate": 1
    }
  },
  "webHookUrl": "text",
  "waitForLock": true
}

application/json-patch+jsonapplication/jsonapplication/*+json

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "C2C",
  "createdAt": "2025-05-04T02:43:02.253Z",
  "quoteId": "123e4567-e89b-12d3-a456-426614174000",
  "payerId": 1,
  "debitAmount": 1,
  "debitCurrency": "text",
  "fxRate": 1,
  "amount": 1,
  "currency": "text",
  "collectMethod": "CASH_PICKUP",
  "referenceId": "text",
  "userInfo": {
    "Dbtr": {
      "StrdNm": {
        "FirstNm": "text",
        "LastNm": "text"
      },
      "PstlAdr": {
        "Ctry": "text",
        "CtrySubDvsn": "text",
        "TwnNm": "text",
        "AdrLine": "text",
        "PstCd": "text"
      },
      "Id": {
        "PrvtId": {
          "Othr": {
            "Id": "text",
            "Issr": "text",
            "SchmeNm": {
              "Cd": "ARNU",
              "Prtry": "text"
            }
          },
          "DtAndPlcOfBirth": {
            "BirthDt": "text",
            "CtryOfBirth": "text"
          }
        },
        "OrgId": {
          "Othr": {
            "Id": "text",
            "Issr": "text",
            "SchmeNm": {
              "Cd": "ARNU",
              "Prtry": "text"
            }
          }
        }
      },
      "CtctDtls": {
        "EmailAdr": "text",
        "PhneNb": "text",
        "Othr": "text"
      },
      "Nm": "text"
    },
    "Cdtr": {
      "StrdNm": {
        "FirstNm": "text",
        "LastNm": "text"
      },
      "PstlAdr": {
        "Ctry": "text",
        "CtrySubDvsn": "text",
        "TwnNm": "text",
        "AdrLine": "text",
        "PstCd": "text"
      },
      "Id": {
        "PrvtId": {
          "Othr": {
            "Id": "text",
            "Issr": "text",
            "SchmeNm": {
              "Cd": "ARNU",
              "Prtry": "text"
            }
          },
          "DtAndPlcOfBirth": {
            "BirthDt": "text",
            "CtryOfBirth": "text"
          }
        }
      },
      "CtctDtls": {
        "EmailAdr": "text",
        "PhneNb": "text",
        "Othr": "text"
      }
    },
    "CdtrAgt": {
      "FinInstnId": {
        "BICFI": "text"
      },
      "BrnchId": {
        "Id": "text"
      }
    },
    "CdtrAcct": {
      "Id": {
        "Othr": {
          "Id": "text"
        }
      },
      "Tp": {
        "Cd": "SVGS"
      }
    },
    "Purp": {
      "Prtry": "FAMILY_SUPPORT"
    },
    "InstForCdtrAgt": {
      "InstrInf": "text"
    },
    "PmtId": {
      "TxId": "text"
    }
  },
  "status": "CREATED",
  "subState": "FORWARDED",
  "lockDeclineReason": "text",
  "lockDeclineDescription": "text",
  "reverseReason": "text",
  "withholdingPercentages": {
    "vatWithholdingPercentage": 1,
    "incomeWithholdingPercentage": 1,
    "vatWithholdingReceiptUrl": "text",
    "incomeWithholdingReceiptUrl": "text"
  },
  "payerPaymentCode": "text",
  "transactionId": 1,
  "lockedAt": "2025-05-04T02:43:02.253Z",
  "lockDeclinedAt": "2025-05-04T02:43:02.253Z",
  "expiredAt": "2025-05-04T02:43:02.253Z",
  "settledAt": "2025-05-04T02:43:02.253Z",
  "forwardedAt": "2025-05-04T02:43:02.253Z",
  "awaitingCollectionSince": "2025-05-04T02:43:02.253Z",
  "completedAt": "2025-05-04T02:43:02.253Z",
  "reversedAt": "2025-05-04T02:43:02.253Z",
  "liquidityError": true,
  "invoiceUrl": "text"
}