Create Bank Transfer Recipient

post

https://api.dev.givecard.dev/api/v1/bankTransfers/recipient

Creates a recipient entity, representing a real person who will receive transfers. You can attach bank accounts to a recipient using the 'Add Bank Account to Recipient' endpoint if you have the account details or by collecting them through GiveCard Intake. To request a recipient's bank details, set 'email' as the IntakeDeliveryType. The intake process also verifies the bank account details are valid. Once the account information is collected and verified, you can initiate transfers to the recipient.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

string

Required for GiveCard Intake. This email will be used for payment communication as well, but is optional for non-intake recipients.

firstName

string

Required if the recipient type is 'person'. The recipient's first name, allowing letters, spaces, hyphens, apostrophes, periods, and diacritics.

intakeDeliveryType

string

enum

Allowed:

lastName

string

Required if the recipient type is 'person'. The recipient's last name, allowing letters, spaces, hyphens, apostrophes, periods, and diacritics.

legalBusinessName

string

Required if the recipient type is 'business'. The legal name of the business.

metadata

array of objects

metadata

programId

string

Program ID is only required for superbusinesses.

type

string

enum

Specifies whether the recipient is a person or a business. Defaults to 'person' if not provided. person RecipientTypePerson business RecipientTypeBusiness

Allowed:

Headers

Idempotency-Key

string

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200

400

404

409

500