Return Payments

Initiate transaction return

post

Path parameters

customerIdstringRequired

Header parameters

authorizationstringOptional

Authorization header containing your API Token

x-alg-noncestringOptional

Nonce used to generate the payload signature

x-alg-signaturestringOptional

Payload signature

datestringOptional

Date of the request un UTC/GMT

Body

application/json

paymentIdstring · uuidRequired

Payment id of the inbound transaction to be returned

idempotencyKeystring · uuidRequired

returnReasonstring · enumRequired

Reason for initiating the return

Possible values:

returnExplanationstring · max: 500 · nullableOptional

Optional human-readable explanation for the return

externalReferencestring · uuidOptional

Reference identifier provided by partner.

Example: ae588135-0391-42a8-a4e4-e8e7645fa707

Responses

200

Returns transfer response for the initiated return

application/json

paymentIdstring · uuidRequired

Unique identifier of the payment

Example: 1489dd60-aa06-48a6-a267-e7d4a9a84200

processingStatestring · enumRequired

Processing state of the payment

Example: SUCCESSPossible values:

createdOnstring · date-timeRequired

Timestamp when the payment was created

initiationRequestone ofRequired

Original request payload that initiated the payment

or

or

or

400

Input validation error

application/json

403

Forbidden

application/json

408

Request timeout

application/json

412

Precondition failed. Payment cannot be returned due to unsupported transaction type.

application/json

422

Unprocessable entity

application/json

post

/v1/partner/payments/customers/{customerId}/payments/return

HTTPcURLJavaScriptPython

POST /v1/partner/payments/customers/{customerId}/payments/return HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 229

{
  "paymentId": "123e4567-e89b-12d3-a456-426614174000",
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "returnReason": "ACCOUNT_SUSPENDED",
  "returnExplanation": "text",
  "externalReference": "ae588135-0391-42a8-a4e4-e8e7645fa707"
}

{
  "paymentId": "1489dd60-aa06-48a6-a267-e7d4a9a84200",
  "processingState": "SUCCESS",
  "createdOn": "2026-03-18T17:15:23.543Z",
  "transaction": {
    "transactionId": "68c2a19131a3b726fe47fdda",
    "uniqueToken": "1489dd60-aa06-48a6-a267-e7d4a9a84200",
    "origin": "TRANSFER",
    "state": "COMPLETED",
    "category": [
      "TRANSFERS"
    ],
    "impactType": "CREDIT",
    "customerId": "a2b9649e-df7f-4349-adff-1c57283fef10",
    "programId": "a2b9649e-df7f-4349-adff-1c57283fef10",
    "amount": 129,
    "currencyCode": "GBP",
    "description": "Sent from Algbra",
    "exchangeRate": "1.0",
    "exchangeCurrencyCode": "GBP",
    "sourceCounterparty": {
      "type": "PERSONAL",
      "details": {
        "firstName": "John",
        "lastName": "Doe"
      },
      "accountCurrency": "GBP",
      "accountReferenceType": "UK_ACCOUNT",
      "accountReference": {
        "type": "UK_ACCOUNT",
        "sortCode": "010102",
        "accountNumber": "12345678"
      },
      "address": {
        "buildingName": "Eiffel Tower",
        "buildingNumber": "10",
        "state": "Île-de-France",
        "street": "Av. Gustave Eiffel",
        "town": "Paris",
        "postcode": "75007",
        "country": "FRA"
      }
    },
    "destinationCounterparty": {
      "type": "PERSONAL",
      "details": {
        "firstName": "John",
        "lastName": "Doe"
      },
      "accountCurrency": "GBP",
      "accountReferenceType": "UK_ACCOUNT",
      "accountReference": {
        "type": "UK_ACCOUNT",
        "sortCode": "010102",
        "accountNumber": "12345678"
      },
      "address": {
        "buildingName": "Eiffel Tower",
        "buildingNumber": "10",
        "state": "Île-de-France",
        "street": "Av. Gustave Eiffel",
        "town": "Paris",
        "postcode": "75007",
        "country": "FRA"
      }
    },
    "transactionDate": "2025-01-01T10:32:01.162Z",
    "cardMetadata": {
      "phase": "AUTHORIZATION",
      "type": "CARD_PAYMENT",
      "cardToken": "1483d25d-3f00-4d39-90ce-2379a130becd",
      "transactionToken": "1483d25d-3f00-4d39-90ce-2379a130becd",
      "eventToken": "1483d25d-3f00-4d39-90ce-2379a130becd",
      "lastDigits": "1234",
      "scheme": {
        "network": "MasterCard",
        "binPrefix": "5432",
        "referenceId": "ref123"
      },
      "cardAcceptor": {
        "mcc": "5411",
        "name": "Supermarket",
        "city": "London",
        "country": "GB"
      },
      "pos": {
        "cardPresent": true,
        "pinPresent": false,
        "terminalId": "TERM001"
      },
      "merchant": {
        "name": "Tesco",
        "summary": "Hyper-Supermarket",
        "imageUrl": "https://s3.eu-central-1.amazonaws.com/files.node-prod.dateio.cz/m/538VqZ4gn33tVJJWEYa8d3/l",
        "location": {
          "latitude": 51.46358,
          "longitude": -0.1861
        }
      }
    },
    "transferMetadata": {
      "rails": "FASTER_PAYMENTS",
      "transactionProgress": [
        {
          "event": "COMPLETED",
          "date": "2025-01-01T10:16:49.621Z"
        }
      ],
      "fundingSourceProvider": {
        "id": "f49281c0-0840-55bd-95b3-3b46d1d0e9f1",
        "name": "John Doe",
        "type": "PISP",
        "logo": "https://app-static.algbra.com/banklogo/mock-payments-gb-redirect.png"
      },
      "transferType": "OUTBOUND_CONTACT",
      "returnReason": "ACCOUNT_SUSPENDED",
      "returnExplanation": "text"
    }
  },
  "initiationRequest": {
    "sourceAccountId": "e0cab2dd-739f-43de-b131-3e423e935bf1",
    "destinationAccountId": "ae66fcb2-2852-4568-990d-accc78572e4d",
    "idempotencyKey": "1483d25d-3f00-4d39-90ce-2379a130becd",
    "amount": 129,
    "externalReference": "ae588135-0391-42a8-a4e4-e8e7645fa707",
    "description": "Sent from Algbra",
    "verificationMetadata": {
      "verificationType": "SMS_OTP_VERIFIED",
      "verificationReference": "text",
      "exemptionType": "INTERNAL_COUNTERPARTY",
      "exemptionReason": "text"
    },
    "purpose": "PAY_INVOICE"
  }
}