Sign in

v4

OpenAPI 3.1.02026-08-012402353.8 MB

Approve a Card Push Transfer

Approves a Card Push Transfer in a pending_approval state.

post/card_push_transfers/{card_push_transfer_id}/approve

Path parameters

card_push_transfer_idstring required

The identifier of the Card Push Transfer to approve.

Response

Card Push Transfer

account_idstring required

The Account from which the transfer was sent.

business_application_identifier'account_to_account' | 'business_to_business' | 'money_transfer_bank_initiated' | 'non_card_bill_payment' | 'consumer_bill_payment' | 'card_bill_payment' | 'funds_disbursement' | 'funds_transfer' | 'loyalty_and_offers' | 'merchant_disbursement' | 'merchant_payment' | 'person_to_person' | 'top_up' | 'wallet_transfer' 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_idstring required

The ID of the Card Token that was used to validate the card.

created_atstring date-time required

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

idstring required

The Card Push Transfer's identifier.

idempotency_keystring nullable required

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_codestring 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.

merchant_city_namestring required

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

merchant_legal_business_namestring nullable required

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

merchant_namestring required

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

merchant_name_prefixstring 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.

merchant_postal_codestring required

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

merchant_statestring required

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

merchant_street_addressstring nullable required

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

recipient_address_citystring nullable required

The city of the recipient. Required if the card is issued in Canada.

recipient_address_line1string nullable required

The first line of the recipient's address. Required if the card is issued in Canada.

recipient_address_postal_codestring nullable required

The postal code of the recipient. Required if the card is issued in Canada.

recipient_address_statestring nullable required

The state or province of the recipient. Required if the card is issued in Canada.

recipient_namestring required

The name of the funds recipient.

route'visa' | 'mastercard' | 'pulse' required

The card network route used for the transfer.

sender_address_citystring required

The city of the sender.

sender_address_line1string required

The address line 1 of the sender.

sender_address_postal_codestring required

The postal code of the sender.

sender_address_statestring required

The state of the sender.

sender_namestring required

The name of the funds originator.

source_account_number_idstring required

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

status'pending_approval' | 'canceled' | 'pending_submission' | 'pending_reviewing' | 'requires_attention' | 'submitted' | 'complete' | 'declined' required

The lifecycle status of the transfer.

type'card_push_transfer' required

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

Example response

{
  "acceptance": null,
  "account_id": "account_in71c4amph0vgo2qllky",
  "approval": null,
  "business_application_identifier": "funds_disbursement",
  "cancellation": null,
  "card_token_id": "outbound_card_token_zlt0ml6youq3q7vcdlg0",
  "created_at": "2020-01-31T23:59:59Z",
  "created_by": {
    "category": "user",
    "user": {
      "email": "user@example.com"
    }
  },
  "decline": null,
  "id": "outbound_card_push_transfer_e0z9rdpamraczh4tvwye",
  "idempotency_key": null,
  "merchant_category_code": "1234",
  "merchant_city_name": "New York",
  "merchant_legal_business_name": null,
  "merchant_name": "Acme Corp",
  "merchant_name_prefix": "Acme",
  "merchant_postal_code": "10045",
  "merchant_state": "NY",
  "merchant_street_address": null,
  "presentment_amount": {
    "currency": "USD",
    "value": "12.34"
  },
  "recipient_address_city": null,
  "recipient_address_line1": null,
  "recipient_address_postal_code": null,
  "recipient_address_state": null,
  "recipient_name": "Ian Crease",
  "route": "visa",
  "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"
}