Skip to main content
POST
Create recipient

Overview

Create a saved recipient that can be reused across transfers and settlement configuration. Supported types: BANK_ACCOUNT, CRYPTO_ADDRESS, US_BANK_ACCOUNT, and SWIFT_BANK_ACCOUNT. Recipients are deduplicated by fingerprint — submitting the same account details will return the existing recipient rather than creating a duplicate.
Tier 2 verification required for USD recipients:
  • customer_id is required for US_BANK_ACCOUNT and SWIFT_BANK_ACCOUNT types.
  • The referenced customer must have completed tier 2 verification.
  • If the customer does not have a Bridge banking partner ID, USD recipient creation will fail.
For a transfer funded from CUSTOMER_NGN_BALANCE, create the BANK_ACCOUNT recipient with the same customer_id used in on_behalf_of.customer_id. Customer ownership is optional for merchant-funded NGN transfers but required for this customer-scoped flow.

Authentication

string
required
Your merchant API key
string
required
Unique idempotency key to prevent duplicate requestsExample: 550e8400-e29b-41d4-a716-446655440000

Request Body

string
required
Recipient typeAllowed values: BANK_ACCOUNT | CRYPTO_ADDRESS | US_BANK_ACCOUNT | SWIFT_BANK_ACCOUNT
string
Customer ID to associate with this recipient (UUID). Required for US_BANK_ACCOUNT and SWIFT_BANK_ACCOUNT types, whose customer must have completed tier 2 verification. Also required on a BANK_ACCOUNT recipient that will be paid from that customer’s CUSTOMER_NGN_BALANCE.Example: 650e8400-e29b-41d4-a716-446655440000
object
Bank account details. Required when type is BANK_ACCOUNT.
object
Crypto address details. Required when type is CRYPTO_ADDRESS.
object
US bank account details. Required when type is US_BANK_ACCOUNT.
object
SWIFT bank account details. Required when type is SWIFT_BANK_ACCOUNT. For individual recipients, provide first_name and last_name. For business recipients, provide business_name.

Request Example

Response

string
required
Unique recipient identifier (UUID)
string
required
Recipient type (BANK_ACCOUNT, CRYPTO_ADDRESS, US_BANK_ACCOUNT, or SWIFT_BANK_ACCOUNT)
string
Recipient first name (resolved from account details)
string
Recipient last name (resolved from account details)
object
Bank account details. Present when type is BANK_ACCOUNT, null otherwise.
object
Crypto address details. Present when type is CRYPTO_ADDRESS, null otherwise.
object
US bank account details. Present when type is US_BANK_ACCOUNT, null otherwise.
object
SWIFT bank account details. Present when type is SWIFT_BANK_ACCOUNT, null otherwise.
string
required
When the recipient was created (ISO 8601 timestamp)

Success Response

Error Responses

Notes

  • Recipients are deduplicated by fingerprint. If you submit the same account details, the existing recipient is returned instead of creating a duplicate.
  • When account_name is omitted for a BANK_ACCOUNT recipient, the name is resolved automatically from the bank.
  • customer_id is optional for BANK_ACCOUNT and CRYPTO_ADDRESS types, but required for US_BANK_ACCOUNT and SWIFT_BANK_ACCOUNT types.
  • For USD recipient types, the referenced customer must have completed tier 2 verification and have a Bridge banking partner ID.
  • For US_BANK_ACCOUNT and SWIFT_BANK_ACCOUNT, the address.country field must be an ISO 3166-1 alpha-3 country code (e.g. USA, DEU, GBR).

Next Steps

List recipients

Retrieve all saved recipients

Get recipient

Look up a single recipient by ID