Authorize payment

Submit a payment request directly to the Push Authorization Engine.

POST /authorize

Authorize payment

cURL

curl --request POST \
  --url https://api.pushcash.com/authorize \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 1000,
  "token": "token_3r09eejo3r32rjoj3r23r3",
  "credential_id": "cred_7YlA9IiSl8UZvNwNSbFajV",
  "redirect_url": "<string>",
  "webhook_url": "https://api.yourdomain.com/webhooks/push",
  "webhook_secret": "whsec_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
  "tag": "tx_1234567890",
  "account_id": "<string>"
}
'

200

{
  "id": "intent_production_mbDRHFi3dxIZEtykHsgUGC",
  "amount": 1000,
  "direction": "cash_in",
  "currency": "USD",
  "credential": {
    "display_name": "Chase Checking",
    "last4": "6018"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

amount · integer · required

Amount of the payment in the smallest unit of specified currency. For example, $10.00 in USD is 1000.

Example:

1000

currency · enum<string> · required

Currency associated with the amount

Available options: USD

direction · enum<string> · required

Direction of the payment.

• Submit cash_in for deposits
• Submit cash_out for withdrawals

Available options: cash_in, cash_out

token · string

A token returned from the tokens API.

Example:

"token_3r09eejo3r32rjoj3r23r3"

credential_id · string

The payment credential ID to use for the payment

Example:

"cred_7YlA9IiSl8UZvNwNSbFajV"

redirect_url · string

Enable redirects from the authentication flow back to the original application. If omitted, the authentication flow will notify the parent browser via postMessage when the user completes the flow.

webhook_url · string

The HTTPS URL for your webhook callback. For more information, see Enabling Webhooks.

Example:

"https://api.yourdomain.com/webhooks/push"

webhook_secret · string

A cryptographically random string of at least 32 characters. For more information, see Enabling Webhooks.

Required string length: 32 - 4096

Example:

"whsec_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6"

tag · string

Your internal transaction ID for matching webhooks to internal records. For more information, see Enabling Webhooks.

Maximum string length: 255

Example:

"tx_1234567890"

account_id · string

The settlement account for the transaction. For more information, see Multiple Settlement Accounts.

approval_mode · enum<string>

Enable manual review of payouts or redemptions through this parameter. See Manual Review for details.

Available options: automatic, manual

Response

200

application/json

Payment approved

Response for approved payment authorization

id · string · required

The payment intent ID

amount · integer · required

Amount of the payment in the smallest unit of specified currency

direction · enum<string> · required

Direction of the payment.

• Submit cash_in for deposits
• Submit cash_out for withdrawals

Available options: cash_in, cash_out

currency · enum<string> · required

Currency associated with the amount

Available options: USD

credential · object · required

The credentials used for the payment intent

Show child attributes

Example:

{
  "display_name": "Chase Checking",
  "last4": "6018"
}