VOvopay
Credit Card Endpoints

credit-card/set-my-credit-card

This endpoint allows you to identify a credit card as belonging to the VoPay account holder. Optionally, you can use this endpoint to identify a credit card as being the VoPay account holder's default credit card for one or more purposes (Operational, Billing). Note, a VoPay account can only have one default credit card per purpose.

post/credit-card/set-my-credit-card

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/credit-card/set-my-credit-card
  • Auth
    none declared

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

CreditCardTokenstring required

Credit Card token

ClientAccountIDstring

Client Account ID

SetAsDefaultboolean

Identify credit card as default crdit card

Purposestring

Comma separated list of purposes to assign to the credit card: Operational, Billing. When omitted, defaults to 'Operational,Billing' — preserving the original behaviour where the single default card was used for both operational charges and account billing

RemovePurposestring

Purpose to remove the default flag for on this credit card: Operational or Billing

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

CreditCardTokenstring required

Credit Card token

IsDefaultboolean required

Is this the VoPay account holder's default credit card for the requested purpose

Example response

{
  "Success": true,
  "CreditCardToken": "ACBDF-GAFSHD-AHBS-123456",
  "IsDefault": true,
  "Purpose": {
    "0": "Operational"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.