Get a payout | Payment API 0.1.0 | Axiym API documentation

Authorization

Default

AuthorizationBearer <token>

In: header

Path Parameters

paymentId*string

Payment identifier (UUID).

Formatuuid

Header Parameters

X-Request-Id?string

Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in X-Request-Id, or generates one when omitted.

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/payouts/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "paymentId": "c3d65312-6575-43de-b8ae-728d8d0a9371",  "code": "AXI00000420",  "sourceAccount": {    "accountId": "5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e",    "currency": "USD",    "paymentRails": "ZENUS_BANK"  },  "externalReference": "PAYOUT-2026-001",  "status": "PENDING_CONFIRMATION",  "sourceAmount": {    "amount": "1010.00",    "currency": "USD"  },  "fee": {    "amount": "10.00",    "currency": "USD"  },  "destinationAmount": {    "amount": "56500.00",    "currency": "PHP"  },  "rate": "56.5000",  "termsExpireAt": "2026-09-07T10:05:00Z",  "sender": {    "name": "Acme Pte. Ltd.",    "countryOfIncorporation": "SG",    "address": {      "streetName": "1 Raffles Place",      "city": "Singapore",      "postalCode": "048616",      "country": "SG"    },    "contact": {      "email": "payments@acme.example",      "phoneNumber": "+6591234567"    },    "identification": {      "type": "REGISTRATION_NUMBER",      "number": "202612345N",      "country": "SG",      "documents": [        {          "documentType": "REGISTRY_EXTRACT",          "fileId": "6c1d0e42-8b7a-4f39-9d21-3a5e7c9b1f08",          "name": "acme-registry-extract.pdf",          "contentType": "application/pdf",          "size": 96311        }      ]    },    "relationships": [      {        "role": "UBO",        "firstName": "Alex",        "lastName": "Tan",        "nationalities": [          "SG"        ],        "address": {          "streetName": "10 Anson Road",          "city": "Singapore",          "postalCode": "079903",          "country": "SG"        },        "identification": {          "type": "PASSPORT",          "number": "E1234567A",          "country": "SG"        }      }    ]  },  "recipient": {    "businessRelationship": "SUPPLIER",    "name": "Manila Software Services Inc.",    "countryOfIncorporation": "PH",    "address": {      "streetName": "6789 Ayala Avenue",      "city": "Makati",      "postalCode": "1226",      "country": "PH"    },    "contact": {      "email": "accounts@manilasoftware.example",      "phoneNumber": "+639171234567"    },    "destination": {      "accountNumber": "123456789012",      "currency": "PHP",      "bank": {        "bankName": "Example Bank Philippines",        "address": {          "country": "PH"        },        "swiftBic": "BNORPHMMXXX"      }    }  },  "sourceOfFunds": "BUSINESS_INCOME",  "purpose": "SERVICES_PAYMENT",  "reference": "INV-2026-0917",  "supportingDocuments": [    {      "documentType": "INVOICE",      "fileId": "0f6a2c91-4b7e-4d31-9c58-2e8a1f6b3d40",      "name": "INV-2026-0917.pdf",      "contentType": "application/pdf",      "size": 184233    }  ],  "createdAt": "2026-09-07T10:00:00Z",  "updatedAt": "2026-09-07T10:00:00Z"}

Authorization

Path Parameters

Header Parameters

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

422application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`