Create recipient
Recipients
Create recipient
Create a saved transfer or settlement destination
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_idis required forUS_BANK_ACCOUNTandSWIFT_BANK_ACCOUNTtypes.- 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.
Authentication
Your merchant API key
Unique idempotency key to prevent duplicate requestsExample:
550e8400-e29b-41d4-a716-446655440000Request Body
Recipient typeAllowed values:
BANK_ACCOUNT | CRYPTO_ADDRESS | US_BANK_ACCOUNT | SWIFT_BANK_ACCOUNTCustomer ID to associate with this recipient (UUID). Required for
US_BANK_ACCOUNT and SWIFT_BANK_ACCOUNT types. The customer must have completed tier 2 verification.Example: 650e8400-e29b-41d4-a716-446655440000Bank account details. Required when
type is BANK_ACCOUNT.Crypto address details. Required when
type is CRYPTO_ADDRESS.US bank account details. Required when
type is US_BANK_ACCOUNT.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
Unique recipient identifier (UUID)
Recipient type (
BANK_ACCOUNT, CRYPTO_ADDRESS, US_BANK_ACCOUNT, or SWIFT_BANK_ACCOUNT)Recipient first name (resolved from account details)
Recipient last name (resolved from account details)
Bank account details. Present when
type is BANK_ACCOUNT, null otherwise.Crypto address details. Present when
type is CRYPTO_ADDRESS, null otherwise.US bank account details. Present when
type is US_BANK_ACCOUNT, null otherwise.SWIFT bank account details. Present when
type is SWIFT_BANK_ACCOUNT, null otherwise.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_nameis omitted for aBANK_ACCOUNTrecipient, the name is resolved automatically from the bank. customer_idis optional forBANK_ACCOUNTandCRYPTO_ADDRESStypes, but required forUS_BANK_ACCOUNTandSWIFT_BANK_ACCOUNTtypes.- For USD recipient types, the referenced customer must have completed tier 2 verification and have a Bridge banking partner ID.
- For
US_BANK_ACCOUNTandSWIFT_BANK_ACCOUNT, theaddress.countryfield 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