Outbound Payments

POSThttps://api.algbralabs.com/v1/partner/payments/external

Header parameters

Body

application/json

sourceAccountId*string (uuid)

destinationCounterparty*PartnerPaymentCounterpartyPayload (object)

idempotencyKey*string (uuid)

amount*number

Amount in hundreds, ie. for £1.2 enter 120

Example: 129

Response

200

Returns payment id to be used in the next step

Body

application/json

sourceAccountId*string (uuid)

destinationAccountId*string (uuid)

idempotencyKey*string (uuid)

amount*number

Amount in hundreds, ie. for £1.2 enter 120

Example: 129

paymentId*string (uuid)

Request

JavaScriptCurl

const response = await fetch('https://api.algbralabs.com/v1/partner/payments/external', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "sourceAccountId": "123e4567-e89b-12d3-a456-426614174000",
      "destinationCounterparty": {
        "type": "PERSONAL",
        "details": {
          "firstName": "John",
          "lastName": "Doe"
        },
        "accountCurrency": "GBP",
        "accountReferenceType": "UK_ACCOUNT",
        "accountReference": {
          "type": "UK_ACCOUNT",
          "sortCode": "010102",
          "accountNumber": "12345678"
        }
      },
      "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
      "amount": 129
    }),
});
const data = await response.json();

Response

{
  "sourceAccountId": "123e4567-e89b-12d3-a456-426614174000",
  "destinationAccountId": "123e4567-e89b-12d3-a456-426614174000",
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "amount": 129,
  "paymentId": "123e4567-e89b-12d3-a456-426614174000"
}