increase-test
POST/card_push_transfers

Create a Card Push Transfer

Creates a Card Push Transfer to send funds to a recipient's payment card in real time. Provide the source account, card token, transfer amount, and merchant and sender details; your program must be approved for the selected Business Application Identifier and merchant category code. Some merchant and recipient address fields are required when the card is issued in Canada.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

23 body fields

Card Push Transfer details, including the source account, recipient card token, amount, and merchant and sender information. The required fields are source_account_number_id, card_token_id, presentment_amount, merchant_city_name, merchant_state, merchant_postal_code, merchant_category_code, merchant_name, merchant_name_prefix, sender_name, sender_address_line1, sender_address_city, sender_address_state, sender_address_postal_code, and recipient_name.

business_application_identifierstringrequired
The Business Application Identifier describes the type of transaction being performed. Your program must be approved for the specified Business Application Identifier in order to use it.
Allowed:account_to_accountbusiness_to_businessmoney_transfer_bank_initiatednon_card_bill_paymentconsumer_bill_paymentcard_bill_paymentfunds_disbursementfunds_transferloyalty_and_offersmerchant_disbursementmerchant_paymentperson_to_person
card_token_idstringrequired
The Increase identifier for the Card Token that represents the card number you're pushing funds to.
merchant_category_codestringrequired
The merchant category code (MCC) of the merchant (generally your business) sending the transfer. This is a four-digit code that describes the type of business or service provided by the merchant. Your program must be approved for the specified MCC in order to use it.
merchant_city_namestringrequired
The city name of the merchant (generally your business) sending the transfer.
merchant_legal_business_namestringoptional
The legal business name of the merchant (generally your business) sending the transfer. Required if the card is issued in Canada.
merchant_namestringrequired
The merchant name shows up as the statement descriptor for the transfer. This is typically the name of your business or organization.
merchant_name_prefixstringrequired
For certain Business Application Identifiers, the statement descriptor is `merchant_name_prefix*sender_name`, where the `merchant_name_prefix` is a one to four character prefix that identifies the merchant.
merchant_postal_codestringrequired
The postal code of the merchant (generally your business) sending the transfer.
merchant_statestringrequired
The state of the merchant (generally your business) sending the transfer.
merchant_street_addressstringoptional
The street address of the merchant (generally your business) sending the transfer. Required if the card is issued in Canada.
presentment_amountobjectrequired
The amount to transfer. The receiving bank will convert this to the cardholder's currency. The amount that is applied to your Increase account matches the currency of your account.
recipient_address_citystringoptional
The city of the recipient. Required if the card is issued in Canada.
recipient_address_line1stringoptional
The first line of the recipient's address. Required if the card is issued in Canada.
recipient_address_postal_codestringoptional
The postal code of the recipient. Required if the card is issued in Canada.
recipient_address_statestringoptional
The state or province of the recipient. Required if the card is issued in Canada.
recipient_namestringrequired
The name of the funds recipient.
require_approvalbooleanoptional
Whether the transfer requires explicit approval via the dashboard or API.
sender_address_citystringrequired
The city of the sender.
sender_address_line1stringrequired
The address line 1 of the sender.
sender_address_postal_codestringrequired
The postal code of the sender.
sender_address_statestringrequired
The state of the sender.
sender_namestringrequired
The name of the funds originator.
source_account_number_idstringrequired
The identifier of the Account Number from which to send the transfer.

3 status codes
200Returns the created Card Push Transfer object, including its identifier, status, source Account, recipient Card Token, amount, and merchant details.
acceptanceobjectrequired
If the transfer is accepted by the recipient bank, this will contain supplemental details.
account_idstringrequired
The Account from which the transfer was sent.
approvalobjectrequired
If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
business_application_identifierstringrequired
The Business Application Identifier describes the type of transaction being performed. Your program must be approved for the specified Business Application Identifier in order to use it.
Allowed:account_to_accountbusiness_to_businessmoney_transfer_bank_initiatednon_card_bill_paymentconsumer_bill_paymentcard_bill_paymentfunds_disbursementfunds_transferloyalty_and_offersmerchant_disbursementmerchant_paymentperson_to_person
cancellationobjectrequired
If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
card_token_idstringrequired
The ID of the Card Token that was used to validate the card.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.
created_byobjectrequired
What object created the transfer, either via the API or the dashboard.
declineobjectrequired
If the transfer is rejected by the card network or the destination financial institution, this will contain supplemental details.
idstringrequired
The Card Push Transfer's identifier.
idempotency_keystringrequired
The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).
merchant_category_codestringrequired
The merchant category code (MCC) of the merchant (generally your business) sending the transfer. This is a four-digit code that describes the type of business or service provided by the merchant. Your program must be approved for the specified MCC in order to use it.
merchant_city_namestringrequired
The city name of the merchant (generally your business) sending the transfer.
merchant_legal_business_namestringrequired
The legal business name of the merchant (generally your business) sending the transfer.
merchant_namestringrequired
The merchant name shows up as the statement descriptor for the transfer. This is typically the name of your business or organization.
merchant_name_prefixstringrequired
For certain Business Application Identifiers, the statement descriptor is `merchant_name_prefix*sender_name`, where the `merchant_name_prefix` is a one to four character prefix that identifies the merchant.
merchant_postal_codestringrequired
The postal code of the merchant (generally your business) sending the transfer.
merchant_statestringrequired
The state of the merchant (generally your business) sending the transfer.
merchant_street_addressstringrequired
The street address of the merchant (generally your business) sending the transfer.
presentment_amountobjectrequired
The amount that was transferred. The receiving bank will have converted this to the cardholder's currency. The amount that is applied to your Increase account matches the currency of your account.
recipient_address_citystringrequired
The city of the recipient. Required if the card is issued in Canada.
recipient_address_line1stringrequired
The first line of the recipient's address. Required if the card is issued in Canada.
recipient_address_postal_codestringrequired
The postal code of the recipient. Required if the card is issued in Canada.
recipient_address_statestringrequired
The state or province of the recipient. Required if the card is issued in Canada.
recipient_namestringrequired
The name of the funds recipient.
routestringrequired
The card network route used for the transfer.
Allowed:visamastercardpulse
sender_address_citystringrequired
The city of the sender.
sender_address_line1stringrequired
The address line 1 of the sender.
sender_address_postal_codestringrequired
The postal code of the sender.
sender_address_statestringrequired
The state of the sender.
sender_namestringrequired
The name of the funds originator.
source_account_number_idstringrequired
The Account Number the recipient will see as having sent the transfer.
statusstringrequired
The lifecycle status of the transfer.
Allowed:pending_approvalcanceledpending_submissionpending_reviewingrequires_attentionsubmittedcompletedeclined
submissionobjectrequired
After the transfer is submitted to the card network, this will contain supplemental details.
typestringrequired
A constant representing the object's type. For this resource it will always be `card_push_transfer`.
Allowed:card_push_transfer
4XXReturned when the request encounters a client-side error.
5XXReturned when the request encounters a server-side error.

Error handling

The body must include source_account_number_id, card_token_id, presentment_amount, merchant_city_name, merchant_state, merchant_postal_code, merchant_category_code, merchant_name, merchant_name_prefix, sender_name, sender_address_line1, sender_address_city, sender_address_state, sender_address_postal_code, and recipient_name. presentment_amount must include value and currency, and your program must be approved for the specified Business Application Identifier and merchant category code. merchant_category_code must be four digits; the defined city, merchant, and recipient address fields must satisfy their stated length and character constraints, and the applicable merchant and recipient address fields are required for cards issued in Canada.