LogoLogo
  • Overview
  • Authentication
  • Error Codes
  • Payout API
    • Receiver
      • Create New Receiver
      • KYC Verification for Payout
      • Add Receiver Account
        • International
          • Virtual Card
        • Australia (AUD)
          • Direct Entry
        • Canada (CAD)
          • EFT
          • Digital Payment
        • Europe (EUR)
          • SEPA
        • New Zealand (NZD)
          • Direct Credit
        • United States of America (USD)
          • ACH
      • Get Receiver
      • Get Receiver Bank Account
      • Webhooks
    • Payout
      • Create a Payout Transaction
      • Get Payout
      • Webhooks
      • Sandbox Test Helper
    • Balance
      • Get Account Balance
    • Account
      • Get Current Account
      • Webhooks
    • Batch
      • Webhooks
Powered by GitBook
LogoLogo

© 2025 Ipay Technologies Pty Ltd

On this page
  • Get Receiver Account By ID
  • Get Receiver Account List From Receiver
Export as PDF
  1. Payout API
  2. Receiver

Get Receiver Bank Account

Get Receiver Account By ID

GET /api/receiver-account/<id>

Get receiver account data under subaccount by ID.

Headers

Name
Value

x-api-key

<token>

signature

<token>

Example request

/api/receiver-account/6dea4c0d-7825-4636-a0b0-c4895d451244

Response

{
    "message": "Receiver found",
    "payload": {
        "id": "6dea4c0d-7825-4636-a0b0-c4895d451244",
        "first_name": "Nademoa",
        "last_name": "Tesla",
        "email": "ex@teslastudio.com",
        "dob": "1973-12-12",
        "gender": "M",
        "aka": "",
        "occupation": "",
        "reference": "4464",
        "mobile_international_dialcode": "61",
        "mobile": "483908899",
        "home_phone_international_dialcode": "",
        "home_phone": "",
        "individual_or_business": "I",
        "abn": "",
        "nzbn": "",
        "acn": "",
        "kyc_status": "completed",
        "address_data": {
            "address": "111/22222",
            "address2": "Paklok Rd",
            "city": "Phuket",
            "state": "PK",
            "country": "THA",
            "postcode": "83110"
        },
        "bank_account_data": {
            "account_number": "111136",
            "bank_code": "ANZ",
            "bsb": "012002"
        },
        "account_data": {
            "receiver_accepted": true,
            "receiver_address_accepted": true,
            "receiver_address_outcome": null
        }
    },
}
{
    "message": "Get receiver account failed",
    "error": [
        {
            "code": "REAC104",
            "message": "Receiver ID not found"
        }
    ]
}

Get Receiver Account List From Receiver

GET /api/receiver-account/receiver/<id>

Get receiver account from receiver.

Headers

Name
Value

x-api-key

<token>

signature

<token>

Example request

/api/receiver-account/receiver/a6980641-e785-447a-960d-036bd29c5ece

Response

{
    "message": "Receiver Account found",
    "payload": [
        {
            "id": "6dea4c0d-7825-4636-a0b0-c4895d451244",
            "first_name": "Nademoa",
            "last_name": "Tesla",
            "email": "ex@teslastudio.com",
            "dob": "1973-12-12",
            "gender": "M",
            "aka": "",
            "occupation": "",
            "reference": "4464",
            "mobile_international_dialcode": "61",
            "mobile": "483908899",
            "home_phone_international_dialcode": "",
            "home_phone": "",
            "individual_or_business": "I",
            "abn": "",
            "nzbn": "",
            "acn": "",
            "kyc_status": "completed",
            "address_data": {
                "address": "111/22222",
                "address2": "Paklok Rd",
                "city": "Phuket",
                "state": "PK",
                "country": "THA",
                "postcode": "83110"
            },
            "bank_account_data": {
                "account_number": "111136",
                "bank_code": "ANZ",
                "bsb": "012002"
            },
            "account_data": {
                "receiver_accepted": true,
                "receiver_address_accepted": true,
                "receiver_address_outcome": null
            }
        },
        {
            "id": "e5b088e1-cf4a-4e91-bb65-3c7e07b9b314",
            "first_name": "Alexa",
            "last_name": "Riverstone",
            "email": "alex@riverstudio.com",
            "dob": "1984-05-23",
            "gender": "F",
            "aka": "",
            "occupation": "",
            "reference": "5589",
            "mobile_international_dialcode": "44",
            "mobile": "7700986543",
            "home_phone_international_dialcode": "",
            "home_phone": "",
            "individual_or_business": "I",
            "abn": "",
            "nzbn": "",
            "acn": "",
            "kyc_status": "completed",
            "address_data": {
                "address": "88/99999",
                "address2": "Evergreen Terrace",
                "city": "Springfield",
                "state": "SP",
                "country": "USA",
                "postcode": "49007"
            },
            "bank_account_data": {
                "account_number": "224455",
                "bank_code": "ANZ",
                "bsb": "031200"
            },
            "account_data": {
                "receiver_accepted": true,
                "receiver_address_accepted": true,
                "receiver_address_outcome": null
            }
        }
    ]
}
{
    "message": "Get receiver account failed",
    "error": [
        {
            "code": "REAC101",
            "message": "Receiver Account ID not found"
        }
    ]
}
PreviousGet ReceiverNextWebhooks

Last updated 4 months ago