WIwirexapp
Recipients

Get recipient by ID

Retrieves a single recipient by its ID.

get/api/v1/recipients/{recipientId}

Request

  • Base URL
    https://api-baas.wirexapp.com
  • URL
    https://api-baas.wirexapp.com/api/v1/recipients/{recipientId}
  • Auth
    • API key in header Authorization
    • or API key in header X-Chain-Id and API key in header X-User-Wallet and API key in header Authorization

Path parameters

recipientIdstring required

Unique identifier of the recipient on which the operation is to be performed

Response

OK

idstring required

Unique identifier of the recipient

Example response

{
  "id": "00000000-0000-0000-0000-000000000001",
  "payment_details": [
    {
      "ach": {
        "account_number": "123456789",
        "bank_name": "Bank of America",
        "legal_address": {
          "city": "Los Angeles",
          "country": "US",
          "line1": "123 Main St",
          "line2": "Suite 456",
          "state": "CA",
          "zip_code": "12345"
        },
        "routing_number": "123456789"
      },
      "bi_fast": {
        "account_number": "1234567890",
        "bank_code": "014",
        "bank_name": "Bank Central Asia",
        "destination_country": "ID",
        "recipient_name": "John Doe"
      },
      "card": {
        "card_id": "123456789",
        "card_pan_last": "1234"
      },
      "cross_chain_crypto": {
        "address": "DYw8jCTfwHNRJhhmFcbXvVDTqWMEVFBX6ZKUmG5CNSKK",
        "network": "Solana",
        "tag": "123456"
      },
      "crypto": {
        "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
        "network": "Arbitrum",
        "recipient_address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"
      },
      "currencies": [
        "EUR",
        "USDT"
      ],
      "faster_payment": {
        "account_number": "12345678",
        "sort_code": "123456"
      },
      "fps_hk": {
        "bank_code": "004",
        "fps_id": "1234567890",
        "fps_id_type": "MOBILE",
        "legal_address": {
          "city": "Los Angeles",
          "country": "US",
          "line1": "123 Main St",
          "line2": "Suite 456",
          "state": "CA",
          "zip_code": "12345"
        },
        "recipient_name": "John Doe"
      },
      "id": "00000000-0000-0000-0000-000000000001",
      "imps": {
        "account_number": "1234567890",
        "bank_name": "HDFC Bank",
        "destination_country": "IN",
        "ifsc_code": "HDFC0001234",
        "recipient_name": "John Doe"
      },
      "instapay": {
        "account_number": "1234567890",
        "bank_code": "BDO",
        "bank_name": "BDO Unibank",
        "destination_country": "PH",
        "recipient_name": "John Doe"
      },
      "ipp": {
        "bank_name": "Emirates NBD",
        "destination_country": "AE",
        "iban": "AE070331234567890123456",
        "recipient_name": "John Doe"
      },
      "nip": {
        "account_number": "1234567890",
        "bank_code": "044",
        "bank_name": "Access Bank",
        "destination_country": "NG",
        "recipient_name": "John Doe"
      },
      "pix": {
        "legal_address": {
          "city": "Los Angeles",
          "country": "US",
          "line1": "123 Main St",
          "line2": "Suite 456",
          "state": "CA",
          "zip_code": "12345"
        },
        "national_id_number": "12345678901",
        "pix_key": "email@example.com",
        "pix_key_type": "EMAIL",
        "recipient_name": "John Doe"
      },
      "pse": {
        "account_number": "1234567890",
        "account_type": "SAVINGS",
        "bank_code": "007",
        "destination_country": "CO",
        "document_number": "1234567890",
        "document_type": "CC",
        "recipient_name": "John Doe"
      },
      "sepa": {
        "bic": "COBADEFF",
        "iban": "DE89370400440532013000"
      },
      "spei": {
        "clabe": "002123456789012345",
        "legal_address": {
          "city": "Los Angeles",
          "country": "US",
          "line1": "123 Main St",
          "line2": "Suite 456",
          "state": "CA",
          "zip_code": "12345"
        },
        "national_id_number": "GAAR850101HDFRRL09"
      },
      "swift": {
        "bank_country": "DE",
        "bank_name": "Deutsche Bank",
        "bic": "COBADEFF",
        "iban": "DE89370400440532013000",
        "legal_address": {
          "city": "Los Angeles",
          "country": "US",
          "line1": "123 Main St",
          "line2": "Suite 456",
          "state": "CA",
          "zip_code": "12345"
        }
      }
    }
  ],
  "personal_info": {
    "company_name": "Acme Inc.",
    "first_name": "Alex",
    "is_business": true,
    "last_name": "Grey",
    "nick_name": "My Wallet"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.