Retrieve customer eligible prepaid cards programs

GET 
/profile/prepaid/programs

Retrieve eligible programs for a customer.

Request

Responses

200

OK

application/json

Schema

Schema

programs

object[]

Array [

cardType CardType (string)required

Possible values: [PHYSICAL, VIRTUAL]

Supported card types. Currently we support only VIRTUAL and PHYSICAL

scheme CardScheme (string)required

Possible values: [VISA, MC]

Card scheme information.

• VISA - VISA
• MC - Mastercard The scheme is derived from the card PAN.

name stringrequired

Program name that will be used for card creation

currencies string[]required

List of supported currencies. Example "EUR"

allowableCards integerrequired

Default value: 1

The number of cards that can be issued with this program.

isDigital booleanrequired

The isDigital field is related only to the 'PHYSICAL' card.

]

Example (from schema)

{
  "programs": [
    {
      "cardType": "PHYSICAL",
      "scheme": "VISA",
      "name": "BRAND-PHYSICAL-MC",
      "currencies": [
        "EUR"
      ],
      "allowableCards": 1,
      "isDigital": false
    }
  ]
}

GET_ELIGIBLE_PROGRAMS

{
  "programs": [
    {
      "cardType": "VIRTUAL",
      "scheme": "MC",
      "name": "BRAND-VIRTUAL-MC-EEA",
      "currencies": [
        "EUR"
      ],
      "allowableCards": 1,
      "isDigital": false
    },
    {
      "cardType": "PHYSICAL",
      "scheme": "MC",
      "name": "BRAND-PHYSICAL-MC-EEA",
      "currencies": [
        "EUR"
      ],
      "allowableCards": 1,
      "isDigital": true
    }
  ]
}

405

Method Not Allowed

application/json

Schema

Schema

error

object

Additional details about an error

code string

The error code.

message string

A description of the error.

details string[]

Details of any parameter value errors.

fieldErrors

object[]

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

DW-OPERATION-NOT-ALLOWED

{
  "error": {
    "code": "DW-OPERATION-NOT-ALLOWED",
    "message": "Operation is not allowed in your account. Contact Paysafe for further details.",
    "details": [
      "Operation is not allowed in your account. Contact Paysafe for further details."
    ]
  }
}

500

Internal Server Error

application/json

Schema

Schema

error

object

Additional details about an error

code string

The error code.

message string

A description of the error.

details string[]

Details of any parameter value errors.

fieldErrors

object[]

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

INTERNAL_ERROR

{
  "error": {
    "code": "DW-INTERNAL-SERVER-ERROR",
    "message": "Internal Server Error.",
    "details": [
      "Internal Server Error."
    ],
    "fieldErrors": []
  }
}

Loading...