Bank Recipient Validation

POST /api/payments/bank-recipient

Check bank account is valid

Header Parameters

• api-key string required
• api-secret string required

application/json

Request Body required

• bankId int64 required

  Bank Identifier

• bankAccountNumber string required

  Bank Account Number

Responses

• 200
• 400

---

Bank account validation success response

Response Headers

• x-request-id any

  Request Id for traceability

*/*

Schema

Schema

• accountValidationStatus string required

  Possible values: [RECIPIENT_VALID, RECIPIENT_CHECK_NOT_SUPPORTED, DESTINATION_INVALID, RECIPIENT_INVALID]

  Recipient status code

• recipient string

  Recipient Name, only present if account validation status is RECIPIENT_VALID

• requestId uuid

  Request Id for traceability

Example (from schema)

{
  "accountValidationStatus": "RECIPIENT_VALID",
  "recipient": "Jay Z",
  "requestId": "d4265597-5317-45fd-8d2f-8012870633d5"
}

Error occurred - bad request

Response Headers

• x-request-id any

  Request Id for traceability

*/*

Schema

Schema

• requestId uuid

  Request Id for traceability

• detail string

  Detail of the message.

• status string

  Possible values: [API_KEYS_INVALID, INTERNAL_ERROR]

  Status

Example (from schema)

{
  "requestId": "d4265597-5317-45fd-8d2f-8012870633d5",
  "detail": "API key not valid or Internal error",
  "status": "INTERNAL_ERROR"
}

Loading...