Retrieve Payment Method

Retrieve a payment method for a specific customer.

You can retrieve all of the customer’s payment methods by omitting the payment_method_id path parameter.

Parameters

Request Path Parameters

- customer
- ID of the customer. String starting with cus_.
- payment_method
- ID of the payment method to update. String starting with card_ or other_.

Request Header Parameters

Response Parameters

- account_last4
- Last four digits of the bank account number or IBAN (International Bank Account Number).
- account_name_inquiry
- Data about the account name inquiry (ANI).
  - account_name_inquiry_result
    Result of the account name inquiry. One of the following values:
    match - Indicates that the name provided in the request fully matched the issuing bank's records.
    partial match - Indicates that the name provided in the request partially matched the issuing bank's records.
    no match - Indicates that the name provided in the request did not match the issuing bank's records.
    not performed - Indicates that the account name inquiry was not performed.
    not supported - Indicates that the payment method does not support account name inquiries.
  - account_name_inquiry_details
    Indicates the degree that the name provided in the request matched the issuing bank's records.
    first_name
    Indicates the result of matching the cardholder's given name. One of the following values:
    match - Indicates that the first name provided in the request fully matched the first name in the issuing bank's records.
    partial match - Indicates that the first name provided in the request partially matched the first name in the issuing bank's records.
    no match - Indicates that first the name provided in the request did not match the first name in the issuing bank's records.
    middle_name
    indicates the result of matching the cardholder's middle name. One of the following values:
    match - Indicates that the middle name provided in the request fully matched the middle name in the issuing bank's records.
    partial match - Indicates that the middle name provided in the request partially middle the first name in the issuing bank's records.
    no match - Indicates that the middle name provided in the request did not match the middle name in the issuing bank's records.
    last_name
    indicates the result of matching the cardholder's family name. One of the following values:
    match - Indicates that the last name provided in the request fully matched the family name in the issuing bank's records.
    partial match - Indicates that the last name provided in the request partially matched the family name in the issuing bank's records.
    no match - Indicates that the last name provided in the request did not match the family name in the issuing bank's records.
- account_number
- Bank account number.
- acs_check
- Results of the Access Control Server (ACS) check. Possible values:
  - pass
  - fail
  - unavailable
  - unchecked
  Relevant to cards.
- address
- Describes a physical address. For details about the fields of the 'address' object, see Create Address.
- bic_swift
- BIC or SWIFT code.
- bin_details
- Bank identification details. Includes the following fields:
  bin_number
  BIN number of the bank.
  brand
  The brand of the card. For example, Visa.
  country
  Country of the bank that issued the card.
  type
  The type of the card:
  credit
  debit
  prepaid
- category
- Category of payment method. One of the following:
  bank_redirect
  bank_transfer
  card
  card_redirect
  cash
  ewallet
  ewallet_redirect
- company_name
- Name of the customer's company.
- cvv_check
- Verification of the card’s CVV. Valid values:
  - pass
  - fail
  - unavailable
  - unchecked
- expiration_month
- Month of expiration.
  Relevant to cards.
- expiration_year
- Year of expiration.
  Relevant to cards.
- fingerprint_token
- Hash of the card number, expiration date and CVV.
  Relevant to cards.
- first_name
- Customer's first name.
- full_name
- Full name of the cardholder, as submitted for account name inquiry (ANI).
  first_name
  The cardholder's given name.
  middle_name
  The cardholder's middle name.
  last_name
  The cardholder's family name.
- id
- ID of the payment method. String starting with card_ or other_.
- image
- A URL to the image of the icon for the type of payment method.
- is_default
- Indicates that the added payment method will become the customer's default payment method. If it is the only payment method of the customer then it will automatically become the default payment method even if this parameter is set to false.
- language
- Determines the default language of the hosted page. For a list of values, see List Supported Languages.
  When this parameter is null, the language of the user's browser is used.
  If the language of the user's browser cannot be determined, the default language is English.
- last4
- Last four digits of the card or IBAN (International Bank Account Number).
- metadata
- A JSON object defined by the client. See Metadata.
- name
- Full name of the customer.
- next_action
- Indicates the next action for completing the payment. One of the following values:
  3d_verification - The next action is 3DS authentication. Relevant only to card payments.
  pending_capture - The next action is pending the capture of the amount. Relevant only to card payments when the amount is not zero.
  pending_confirmation - The next action is pending the confirmation for the payment. Relevant to all payment methods excluding card payment.
  not_applicable - The payment has completed or the next action is not relevant.
- payment_purpose
- Purpose of the transfer, as reported by the payer's bank.
- proof_of_authorization
- Proof of authorization for the bank transfer.
- redirect_url
- URL of the hosted page that is shown to the customer.
- routing_number
- Routing number for the bank transfer.
- supporting_documentation
- Reserved.
- type
- Name of the payment method type. For example, us_mastercard_card.
  To get a list of payment methods for a country, use List Payment Methods by Country.
- webhook_url
- Reserved.

Code Samples

.NET

using System;

namespace RapydApiRequestSample
{
    class Program
    {
        static void Main(string[] args)
        {
            try
            {
                string customerId = "cus_478a0ffb8ad771c1bf9736e4b9e2b5f1";
                string paymentMethod = "other_ab7bec8e250bead366f13ca34b130c39";

                string result = RapydApiRequestSample.Utilities.MakeRequest("POST", $"/v1/customers/{customerId}/payment_methods/{paymentMethod}");

                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Error completing request: " + e.Message);
            }
        }
    }
}

JavaScript

const makeRequest = require('<path-to-your-utility-file>/utilities').makeRequest;

async function main() {
  try {
    const result = await makeRequest(
      'GET',
      '/v1/customers/cus_478a0ffb8ad771c1bf9736e4b9e2b5f1/payment_methods/other_ab7bec8e250bead366f13ca34b130c39'
    );

    console.log(result);
  } catch (error) {
    console.error('Error completing request', error);
  }
}

PHP

<?php
$path = $_SERVER['DOCUMENT_ROOT'];
$path .= "/<path-to-your-utility-file>/utilities.php";
include($path);

try {
    $object = make_request('get', "/v1/customers/cus_478a0ffb8ad771c1bf9736e4b9e2b5f1/payment_methods/other_ab7bec8e250bead366f13ca34b130c39");
    var_dump($object);
} catch (Exception $e) {
    echo "Error: $e";
}
?>

Python

from pprint import pprint

from utilities import make_request

# Retrieve Payment Method
result = make_request(method='get',
                      path='/v1/customers/cus_478a0ffb8ad771c1bf9736e4b9e2b5f1/payment_methods/other_ab7bec8e250bead366f13ca34b130c39')
pprint(result)

/v1/customers/:customer/payment_methods/:payment_method

Retrieve Payment Method - Cash

curl -X get 'https://sandboxapi.rapyd.net/v1/customers/cus_4e25112ac20e144ad073a614dc46934b/payment_methods/other_0bfa8ede2535263dab8da20a384d5c2f' \
-H 'access_key: your-access-key-here' \
-H 'Content-Type: application/json' \
-H 'salt: your-random-string-here' \
-H 'signature: your-calculated-signature-here' \
-H 'timestamp: your-unix-timestamp-here'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "98c3c4e4-8e39-42e3-afce-cff0dc481218"
    },
    "data": {
        "id": "other_0bfa8ede2535263dab8da20a384d5c2f",
        "type": "pe_banco_ripley_cash",
        "category": "cash",
        "metadata": {},
        "image": "",
        "webhook_url": "",
        "supporting_documentation": "",
        "next_action": "not_applicable"
    }
}

Retrieve Payment Method - Bank Redirect

curl -X get 'https://sandboxapi.rapyd.net/v1//customers/cus_4e25112ac20e144ad073a614dc46934b/payment_methods/other_c2cda8224983ff286fec562292f9950f' \
-H 'access_key: your-access-key-here' \
-H 'Content-Type: application/json' \
-H 'salt: your-random-string-here' \
-H 'signature: your-calculated-signature-here' \
-H 'timestamp: your-unix-timestamp-here'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "f341cd8c-d0f4-4826-a517-f183ec6b9d3a"
    },
    "data": {
        "id": "other_c2cda8224983ff286fec562292f9950f",
        "type": "at_sofort_bank",
        "category": "bank_redirect",
        "metadata": {},
        "image": "",
        "webhook_url": "",
        "supporting_documentation": "",
        "next_action": "not_applicable",
        "bic_swift": "",
        "account_last4": ""
    }
}

In this section:

Documentation

Retrieve Payment Method

Parameters

Request Path Parameters

Request Header Parameters

Response Parameters

Code Samples

Search results