Inactivate payment method

post https://api.reepay.com/v1/payment_method/{id}/inactivate

A payment method can be inactivated. An inactivated payment method will not be used to pay invoices.

Errors

The operation can generate the following errors beside the generic HTTP error codes described here.

Error code	HTTP code	Description
`40`	`404`	Payment method not found
`42`	`400`	Payment method not active

Responses

Response body

object

string

required

length ≥ 1

Unique id for payment method

state

string

required

length ≥ 1

State of the payment method: active, inactivated, failed, pending or deleted

active inactivated failed pending deleted

customer

string

required

length ≥ 1

Customer by handle

reference

string

Optional reference provided when creating the payment method. For payment methods created with Frisbii Checkout the reference will correspond to the session id for the Checkout session that created the payment method.

failed

date-time

Date when the payment method failed. In ISO-8601 extended offset date-time format.

created

date-time

required

Date when the payment method was created. In ISO-8601 extended offset date-time format.

card

object

Card object in case of Apple Pay payment method

gateway

string

required

length ≥ 1

Card gateway tied to card

fingerprint

string

Uniquely identifies this particular card number

reactivated

date-time

Date and time of reactivation if the card has been reactivated from failed state. In ISO-8601 extended offset date-time format.

gw_ref

string

required

length ≥ 1

Card gateway reference id

card_type

string

required

length ≥ 1

Card type: unknown, visa, mc, dankort, visa_dk, ffk, visa_elec, maestro, laser, amex, diners, discover, jcb or china_union_pay

unknown visa mc dankort visa_dk ffk visa_elec maestro laser amex diners discover jcb china_union_pay

transaction_card_type

string

Card type used in authentication and the card type used for subsequent MIT transactions. Will differ from card_type if co-branded card. unknown, visa, mc, dankort, visa_dk, ffk, visa_elec, maestro, laser, amex, diners, discover, jcb or china_union_pay

unknown visa mc dankort visa_dk ffk visa_elec maestro laser amex diners discover jcb china_union_pay

card_agreement

string

required

length ≥ 1

Card agreement id

exp_date

string

Card expire date on form MM-YY

masked_card

string

Masked card number

last_success

date-time

Date and time of last successful use of the card. In ISO-8601 extended offset date-time format.

last_failed

date-time

Date and time of last failed use of the card. In ISO-8601 extended offset date-time format.

first_fail

date-time

Date and time of first successful use of the card. In ISO-8601 extended offset date-time format.

error_code

string

An error code from the last failed use of the card. See transaction errors.

error_state

string

Error state from last failed use of the card: pending, soft_declined, hard_declined or processing_error

pending soft_declined hard_declined processing_error

declined_count

int32

Number of soft and hard declined attempts for the card since created or since last successful transaction

strong_authentication_status

string

Status for strong customer authentication: threed_secure - 3D Secure authenticated, threed_secure_not_enrolled - 3D Secure authentication not performed as card not enrolled, secured_by_nets - Secure by Nets authenticated

threed_secure threed_secure_not_enrolled secured_by_nets

three_d_secure_status

string

If 3D Secure authenticated the 3D status will either be Y (fully authenticated) or A (attempted authenticated). An attempted authentication means that card issuer (e.g. bank) does not support 3D Secure so no full authentication has been performed. Attempted authentication normally means liability shift, but this can differ between acquirers.

risk_rule

string

If this parameter is set the card has been flagged by Frisbii Risk Filter with a flag rule. Special attention may be required before using the card for recurring payments or subscription sign-up.

card_country

string

Card issuing country in ISO 3166-1 alpha-2

token_state

string

State of tokenization for card active, suspended or deleted

active suspended deleted

applepay

object

Card object in case of Apple Pay payment method

gateway

string

required

length ≥ 1

Card gateway tied to card

fingerprint

string

Uniquely identifies this particular card number

reactivated

date-time

Date and time of reactivation if the card has been reactivated from failed state. In ISO-8601 extended offset date-time format.

gw_ref

string

required

length ≥ 1

Card gateway reference id

card_type

string

required

length ≥ 1

Card type: unknown, visa, mc, dankort, visa_dk, ffk, visa_elec, maestro, laser, amex, diners, discover, jcb or china_union_pay

unknown visa mc dankort visa_dk ffk visa_elec maestro laser amex diners discover jcb china_union_pay

transaction_card_type

string

unknown visa mc dankort visa_dk ffk visa_elec maestro laser amex diners discover jcb china_union_pay

card_agreement

string

required

length ≥ 1

Card agreement id

exp_date

string

Card expire date on form MM-YY

masked_card

string

Masked card number

last_success

date-time

Date and time of last successful use of the card. In ISO-8601 extended offset date-time format.

last_failed

date-time

Date and time of last failed use of the card. In ISO-8601 extended offset date-time format.

first_fail

date-time

Date and time of first successful use of the card. In ISO-8601 extended offset date-time format.

error_code

string

An error code from the last failed use of the card. See transaction errors.

error_state

string

Error state from last failed use of the card: pending, soft_declined, hard_declined or processing_error

pending soft_declined hard_declined processing_error

declined_count

int32

Number of soft and hard declined attempts for the card since created or since last successful transaction

strong_authentication_status

string

threed_secure threed_secure_not_enrolled secured_by_nets

three_d_secure_status

string

risk_rule

string

If this parameter is set the card has been flagged by Frisbii Risk Filter with a flag rule. Special attention may be required before using the card for recurring payments or subscription sign-up.

card_country

string

Card issuing country in ISO 3166-1 alpha-2

token_state

string

State of tokenization for card active, suspended or deleted

active suspended deleted

payment_type

string

required

Payment type for saved payment method, either: card, emv_token, vipps_recurring, applepay, mobilepay_subscriptions, sepa, offline_cash, offline_bank_transfer or offline_other

card emv_token vipps_recurring applepay mobilepay_subscriptions sepa offline_cash offline_bank_transfer offline_other

mps_subscription

object

MPS subscription object in case of MPS payment method

external_id

string

Optional external id at MobilePay defined when creating the subscription

vipps_recurring_mandate

object

Vipps Recurring mandate object in case of Vipps Recurring payment method

Has additional fields

sepa_mandate

object

SEPA mandate object in case of SEPA payment method

iban

string

sepa_mandate_bank_reference

string

twint_mandate

object

Twint mandate object in case of Twint payment method

Has additional fields

offline_mandate

object

Offline mandate object in case of Offline payment method

offline_agreement_handle

string

required

Offline agreement handle

offline_agreement_name

string

Optional offline agreement name

paypal_mandate

object

PayPal mandate object in case of PayPal payment method

Has additional fields

Language

Credentials

Basic

base64


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.reepay.com/v1/payment_method/id/inactivate \
3
     --header 'accept: application/json'


xxxxxxxxxx
67
}
1
{
2
  "id": "ca_fcfac2016614418f969fa5697383e47c",
3
  "state": "active",
4
  "customer": "customer00069",
5
  "reference": "cs_6be90a4babc3c57ef7e6e477ac97ed3b",
6
  "failed": "2015-06-04T12:40:56.656Z",
7
  "created": "2015-04-04T12:40:56.656Z",
8
  "card": {
9
    "gateway": "nets",
10
    "fingerprint": "cst_64e8a26cc0e85bc3f5ce7c5b366b4096",
11
    "reactivated": "2015-05-14T00:00:00Z",
12
    "gw_ref": "657e86162633415a9e6b715248c84da4",
13
    "card_type": "visa_dk",
14
    "transaction_card_type": "visa",
15
    "card_agreement": "2b18c5d1f4dc640d9ff91bfbb2cbcce0",
16
    "exp_date": "09-18",
17
    "masked_card": "457111XXXXXX3777",
18
    "last_success": "2015-05-14T00:00:00Z",
19
    "last_failed": "2015-05-14T00:00:00Z",
20
    "first_fail": "2015-05-14T00:00:00Z",
21
    "error_code": "credit_card_expired",
22
    "error_state": "hard_declined",
23
    "declined_count": 2,
24
    "strong_authentication_status": "secured_by_nets",
25
    "three_d_secure_status": "Y",

Errors

200Successful operation

400Invalid request, see error codes at https://api.reepay.com/v1/error_codes

401None or invalid credentials provided in access to secured resource

403Not authorized to perform resource operation

404Resource or referenced resource not found, see error codes at https://api.reepay.com/v1/error_codes

429Request limiting exceeded, request rate or concurrent requests, see error code 122 and 123

500Internal service error, error is reported automatically to Frisbii