Card Push Transfers

Card Push Transfers send funds to a recipient's payment card in real-time.

The Card Push Transfer object
{ "acceptance": null, "account_id": "account_in71c4amph0vgo2qllky", "amount": 100, "approval": null, "business_application_identifier": "funds_disbursement", "cancellation": null, "created_at": "2020-01-31T23:59:59Z", "created_by": { "category": "user", "user": { "email": "user@example.com" } }, "currency": "USD", "decline": null, "id": "outbound_card_push_transfer_e0z9rdpamraczh4tvwye", "idempotency_key": null, "merchant_category_code": "1234", "merchant_city_name": "New York", "merchant_name": "Acme Corp", "merchant_name_prefix": "Acme", "merchant_postal_code": "10045", "merchant_state": "NY", "recipient_name": "Ian Crease", "sender_address_city": "New York", "sender_address_line1": "33 Liberty Street", "sender_address_postal_code": "10045", "sender_address_state": "NY", "sender_name": "Ian Crease", "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "status": "pending_submission", "submission": null, "type": "card_push_transfer" }
Attributes
acceptance
dictionary
Nullable

If the transfer is accepted by the recipient bank, this will contain supplemental details.

account_id
string

The Account from which the transfer was sent.

amount
integer

The transfer amount in USD cents.

approval
dictionary
Nullable

If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.

business_application_identifier
enum

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.

cancellation
dictionary
Nullable

If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.

created_at
string

The ISO 8601 date and time at which the transfer was created.

created_by
dictionary
Nullable

What object created the transfer, either via the API or the dashboard.

currency
enum

The ISO 4217 code for the transfer's currency.

decline
dictionary
Nullable

If the transfer is rejected by the card network or the destination financial institution, this will contain supplemental details.

id
string

The Card Push Transfer's identifier.

idempotency_key
string
Nullable

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.

merchant_category_code
string

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_name
string

The city name of the merchant (generally your business) sending the transfer.

merchant_name
string

The merchant name shows up as the statement descriptor for the transfer. This is typically the name of your business or organization.

merchant_name_prefix
string

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_code
string

The postal code of the merchant (generally your business) sending the transfer.

merchant_state
string

The state of the merchant (generally your business) sending the transfer.

recipient_name
string

The name of the funds recipient.

sender_address_city
string

The city of the sender.

sender_address_line1
string

The address line 1 of the sender.

sender_address_postal_code
string

The postal code of the sender.

sender_address_state
string

The state of the sender.

sender_name
string

The name of the funds originator.

source_account_number_id
string

The Account Number the recipient will see as having sent the transfer.

status
enum

The lifecycle status of the transfer.

submission
dictionary
Nullable

After the transfer is submitted to the card network, this will contain supplemental details.

type
string

A constant representing the object's type. For this resource it will always be card_push_transfer.

List Card Push Transfers
curl \ --url "${INCREASE_URL}/card_push_transfers?account_id=account_in71c4amph0vgo2qllky" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_id
string

Filter Card Push Transfers to ones belonging to the specified Account.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

status.in
array of strings

Filter Card Push Transfers by status. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

idempotency_key
string

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

200 character maximum
Create a Card Push Transfer
curl -X "POST" \ --url "${INCREASE_URL}/card_push_transfers" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "amount": 100, "business_application_identifier": "funds_disbursement", "card_token_id": "outbound_card_token_zlt0ml6youq3q7vcdlg0", "merchant_category_code": "1234", "merchant_city_name": "New York", "merchant_name": "Acme Corp", "merchant_name_prefix": "Acme", "merchant_postal_code": "10045", "merchant_state": "NY", "recipient_name": "Ian Crease", "sender_address_city": "New York", "sender_address_line1": "33 Liberty Street", "sender_address_postal_code": "10045", "sender_address_state": "NY", "sender_name": "Ian Crease", "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2" }'
Parameters
amount
integer
Required

The transfer amount in USD cents. For Card Push transfers, must be positive.

business_application_identifier
enum
Required

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.

card_token_id
string
Required

The Increase identifier for the Card Token that represents the card number you're pushing funds to.

merchant_category_code
string
Required

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.

4 character maximum
merchant_city_name
string
Required

The city name of the merchant (generally your business) sending the transfer.

13 character maximum
merchant_name
string
Required

The merchant name shows up as the statement descriptor for the transfer. This is typically the name of your business or organization.

25 character maximum
merchant_name_prefix
string
Required

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.

4 character maximum
merchant_postal_code
string
Required

The postal code of the merchant (generally your business) sending the transfer.

10 character maximum
merchant_state
string
Required

The state of the merchant (generally your business) sending the transfer.

200 character maximum
recipient_name
string
Required

The name of the funds recipient.

200 character maximum
require_approval
boolean

Whether the transfer requires explicit approval via the dashboard or API.

sender_address_city
string
Required

The city of the sender.

25 character maximum
sender_address_line1
string
Required

The address line 1 of the sender.

35 character maximum
sender_address_postal_code
string
Required

The postal code of the sender.

10 character maximum
sender_address_state
string
Required

The state of the sender.

200 character maximum
sender_name
string
Required

The name of the funds originator.

30 character maximum
source_account_number_id
string
Required

The identifier of the Account Number from which to send the transfer.

Retrieve a Card Push Transfer
curl \ --url "${INCREASE_URL}/card_push_transfers/outbound_card_push_transfer_e0z9rdpamraczh4tvwye" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
card_push_transfer_id
string
Required

The identifier of the Card Push Transfer.

Approve a Card Push Transfer

Approves a Card Push Transfer in a pending_approval state.

curl -X "POST" \ --url "${INCREASE_URL}/card_push_transfers/outbound_card_push_transfer_e0z9rdpamraczh4tvwye/approve" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
card_push_transfer_id
string
Required

The identifier of the Card Push Transfer to approve.

Cancel a pending Card Push Transfer

Cancels a Card Push Transfer in a pending_approval state.

curl -X "POST" \ --url "${INCREASE_URL}/card_push_transfers/outbound_card_push_transfer_e0z9rdpamraczh4tvwye/cancel" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
card_push_transfer_id
string
Required

The identifier of the pending Card Push Transfer to cancel.