Jump to

• Request
• Response

Retrieves payment instruments for the given type

get

/ccstore/v1/selfservice/payments/{type}/instruments

Fetches payment instruments for the given type. The type can be either ORA_CREDIT_CARD or ORA_WIRE.

Request

Supported Media Types

• application/json

Path Parameters

• type(required): string
  The identifier of the payment to retrieve. The type can be either ORA_CREDIT_CARD or ORA_WIRE

Query Parameters

• q(required): string
  The query to use

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returned when operation succeeds.

Body ()

Root Schema : getPaymentInstruments_success_response

Type: object

Show Source

• AccountNumber: string
  The account number in the Branch
• BankName: string
  The name of the Bank
• BankNumber: string
  The number of the Bank
• BICNumber: string
  The BIC number of the Bank & Branch
• BranchName: string
  The name of the Branch
• BranchNumber: string
  The number of the Branch
• CardExpirydate: string(date)
  The expiry date of the card
• CardHolderName: string
  The name of the card holder
• CardIssuerCode: string
  The code of the card issuer
• CardIssuerName: string
  The name of the card issuer
• CardNumber: string
  The credit/debit card number
• InstrAssignmentId: string
  The instrument assignment ID
• PrimaryFlag: string
  Allowed Values: [ "true", "false" ]

  Indicates if the card is primary

{
    "type":"object",
    "properties":{
        "CardNumber":{
            "description":"The credit/debit card number",
            "type":"string"
        },
        "BankName":{
            "description":"The name of the Bank",
            "type":"string"
        },
        "CardIssuerName":{
            "description":"The name of the card issuer",
            "type":"string"
        },
        "InstrAssignmentId":{
            "description":"The instrument assignment ID",
            "type":"string"
        },
        "PrimaryFlag":{
            "description":"Indicates if the card is primary",
            "type":"string",
            "enum":[
                "true",
                "false"
            ]
        },
        "CardIssuerCode":{
            "description":"The code of the card issuer",
            "type":"string"
        },
        "CardExpirydate":{
            "format":"date",
            "description":"The expiry date of the card",
            "type":"string"
        },
        "CardHolderName":{
            "description":"The name of the card holder",
            "type":"string"
        },
        "AccountNumber":{
            "description":"The account number in the Branch",
            "type":"string"
        },
        "BankNumber":{
            "description":"The number of the Bank",
            "type":"string"
        },
        "BranchNumber":{
            "description":"The number of the Branch",
            "type":"string"
        },
        "BranchName":{
            "description":"The name of the Branch",
            "type":"string"
        },
        "BICNumber":{
            "description":"The BIC number of the Bank & Branch",
            "type":"string"
        }
    }
}

Example Response (application/json)

[
    {
        "CardNumber":"XXXXXXXXXXXX7896",
        "CardIssuerName":"Visa",
        "InstrAssignmentId":"30",
        "PrimaryFlag":"true",
        "CardIssuerCode":"VISA",
        "CardExpirydate":"2019-08-31",
        "CardHolderName":"Computer Service and Rentals"
    },
    {
        "CardNumber":"XXXXXX4900",
        "CardIssuerName":"MasterCard",
        "InstrAssignmentId":"191252",
        "PrimaryFlag":"false",
        "CardIssuerCode":"MASTERCARD",
        "CardExpirydate":"2031-12-31",
        "CardHolderName":"Dexter*Jane"
    },
    {
        "CardNumber":"XXXXXX4900",
        "CardIssuerName":"MasterCard",
        "InstrAssignmentId":"191253",
        "PrimaryFlag":"false",
        "CardIssuerCode":"MASTERCARD",
        "CardExpirydate":"2031-12-31",
        "CardHolderName":"Dexter*Jane"
    },
    {
        "CardNumber":"XXXXXX4900",
        "CardIssuerName":"MasterCard",
        "InstrAssignmentId":"191254",
        "PrimaryFlag":"false",
        "CardIssuerCode":"MASTERCARD",
        "CardExpirydate":"2031-12-31",
        "CardHolderName":"Dexter*Jane"
    },
    {
        "CardNumber":"XXXX3276",
        "CardIssuerName":"Visa",
        "InstrAssignmentId":"195252",
        "PrimaryFlag":"false",
        "CardIssuerCode":"VISA",
        "CardExpirydate":"2025-03-31",
        "CardHolderName":"Jack Reacher"
    },
    {
        "CardNumber":"XXXXXXXXXXXX9876",
        "CardIssuerName":"Unknown",
        "InstrAssignmentId":"194253",
        "PrimaryFlag":"false",
        "CardIssuerCode":"UNKNOWN",
        "CardExpirydate":"2025-04-30",
        "CardHolderName":"Jack Reacher"
    },
    {
        "CardNumber":"XXXXXXXXXXXX6789",
        "CardIssuerName":"Unknown",
        "InstrAssignmentId":"194254",
        "PrimaryFlag":"false",
        "CardIssuerCode":"UNKNOWN",
        "CardExpirydate":"2025-04-30",
        "CardHolderName":"Jack Reacher"
    },
    {
        "CardNumber":"XXXXXX4900",
        "CardIssuerName":"MasterCard",
        "InstrAssignmentId":"191255",
        "PrimaryFlag":"false",
        "CardIssuerCode":"MASTERCARD",
        "CardExpirydate":"2031-12-31",
        "CardHolderName":"Dexter*Jane"
    }
]

Default Response

Returned when operation fails.

Body ()

Root Schema : getPaymentInstruments_failure_response

Back to Top