URL Expired

The URL for this request expired after 30 days.

Schema Definition

Amount

• Type: string
• Required: Yes
• Defaults to: 120.00
• Description: The amount of the payment.

Currency

• Type: string
• Required: Yes
• Defaults to: USD
• Description: The currency of the payment.

cardId

• Type: string
• Required: Yes
• Description: The id of the card that was previously created.

Bank Object

• Type: object
• Required: Yes

Bank ID

• Type: string
• Required: Yes
• Description: The id of the bank that was previously created.

tokenId

• Type: string
• Required: Yes
• Description: The id of a token previously registered.

payerId

• Type: string
• Required: Yes
• Defaults to: fh80g9y3703gpc924m1ateee
• Description: The id of the payer to assign to the card. Required when making a request with bank/card object.

Schedule Object

• Type: object
• Required: Yes

Name

• Type: string
• Defaults to: Monthly Installment
• Description: A name for the scheduled payment.

Description

• Type: string
• Defaults to: Monthly scheduled payment under coupon MarchMadness
• Description: A short description of the scheduled payment.

Meta

• Type: json
• Defaults to: {}
• Description: Optional key/values to help link the scheduled payment to an external system.

customFields

• Type: json
• Defaults to: { "invoiceNumber": "12344" }
• Description: A list of merchant-defined fields.

Example Request

curl --request POST \
     --url https://api.paystand.co/v3/scheduledPayments \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer ••••' \
     --header 'Content-Type: application/json' \
     --data '{
  "amount": "120.00",
  "currency": "USD",
  "bank": {
    "nameOnAccount": "Jessica Lin",
    "accountHolderType": "company",
    "accountNumber": "000123456789",
    "routingNumber": "110000000",
    "accountType": "checking",
    "country": "USA",
    "currency": "USD"
  },
  "payerId": "fh80g9y3703gpc924m1ateee",
  "schedule": {
    "interval": "month",
    "intervalCount": "1",
    "anchor": "start",
    "timesToRun": "12"
  },
  "name": "Monthly Installment",
}'

Response

{
  "status": 200,
  "message": "Success"
}