Skip to main content

Payment Account Reference Response

Payment account proxy response representing the different response structures for card, bank account, PayID, and PayTo details.

accountNamestring

Account name (Bank/PayTo accounts).

Example: John Smith
accountNumberstring

Account number (Bank/PayTo accounts).

Example: 12345678
accountTypestring

Type of payment account.

Example: Card
bsbstring

BSB code (Bank/PayTo accounts).

Example: 123-456
cardExpirystring

Card expiry date (Card accounts only).

Example: 12/25
cardHolderNamestring

Card holder name (Card accounts only).

Example: John Smith
cardNumberstring

Masked card number (Card accounts only).

Example: ****1234
cardTypestring

Card type (Card accounts only).

Example: Visa
payIdstring

PayId identifier (PayId accounts only).

Example: john.smith@email.com
payIdNamestring

PayId display name (PayId accounts only).

Example: John Smith
payToStatusstring

PayTo status (PayTo accounts only).

Example: Active
processor3DSPayloadstring

3DS payload (Card accounts only).

Example: eyJhbGciOiJIUzI1NiJ9...
processorNamestring

Processor name (Card accounts only).

Example: Stripe
processorTokenstring

Processor token (Card accounts only).

Example: tok_1234567890
statusDescriptionstring

Status description (PayTo accounts only).

Example: Account is active and ready for payments
uIdstring

Unique identifier (PayTo accounts only).

Example: 12345678-1234-5678-9012-123456789012
Payment Account Reference Response
{
"accountName": "John Smith",
"accountNumber": "12345678",
"accountType": "Card",
"bsb": "123-456",
"cardExpiry": "12/25",
"cardHolderName": "John Smith",
"cardNumber": "****1234",
"cardType": "Visa",
"payId": "john.smith@email.com",
"payIdName": "John Smith",
"payToStatus": "Active",
"processor3DSPayload": "eyJhbGciOiJIUzI1NiJ9...",
"processorName": "Stripe",
"processorToken": "tok_1234567890",
"statusDescription": "Account is active and ready for payments",
"uId": "12345678-1234-5678-9012-123456789012"
}