Get charge

get https://api.reepay.com/v1/charge/{handle}

Get charge by invoice id or handle

Errors

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

Error code	HTTP code	Description
`31`	`404`	Invoice not found

Responses

Response body

object

handle

string

required

length ≥ 1

Per account unique reference to charge/invoice. E.g. order id from own system. Multiple payments can be attempted for the same handle but only one succeeded charge can exist per handle. Max length 255 with allowable characters [a-zA-Z0-9_.-@].

state

string

required

length ≥ 1

The charge state one of the following: created, authorized, settled, failed, cancelled, pending. A pending state after create charge indicates an async processing has been started for an asynchronous payment method. E.g. MobilePay Subscriptions. See also processing. The result of the charge will be delivered in webhook as either invoice_authorized, invoice_settled or invoice_failed.

created authorized settled failed cancelled pending

customer

string

required

length ≥ 1

Customer handle

amount

int32

required

≥ 0

The invoice amount including VAT. If partial settles are performed amount represents the total settled amount.

currency

string

required

Currency for the account in ISO 4217 three letter alpha code

authorized

date-time

When the charge was authorized, if the charge went through an authorize and settle flow, in ISO-8601 extended offset date-time format.

settled

date-time

When the charge was settled, in ISO-8601 extended offset date-time format.

cancelled

date-time

When the charge was cancelled, in ISO-8601 extended offset date-time format.

created

date-time

required

When the invoice was created, in ISO-8601 extended offset date-time format.

transaction

string

Transaction id assigned by Frisbii. Assigned when transaction is performed.

error

string

Frisbii error code if failed. See transaction errors.

processing

boolean

For asynchronous payment methods this flag indicates that the charge is awaiting result. The charge/invoice state will be pending.

source

object

required

Object describing the source for the charge. E.g. credit card.

type

string

required

Type of charge source: card - existing customer card, card_token - card token, mpo - MobilePay Online, vipps, vipps_epayment, vipps_recurring, swish, viabill, anyday, manual, applepay, googlepay, paypal, klarna_pay_now, klarna_pay_later, klarna_slice_it, klarna_direct_bank_transfer, klarna_direct_debit, resurs, mobilepay_subscriptions, emv_token, bancomatpay, bcmc, blik, pp_blik_oc, giropay, ideal, p24, sepa, trustly, eps, estonia_banks, latvia_banks, lithuania_banks, mb_way, multibanco, mybank, payconiq, paysafecard, paysera, postfinance, satispay, twint, wechatpay, santander, or verkkopankki, offline_cash, offline_bank_transfer, offline_other

card_token card mpo vipps vipps_epayment vipps_recurring swish viabill anyday manual applepay googlepay paypal klarna_pay_now klarna_pay_later klarna_slice_it klarna_direct_bank_transfer klarna_direct_debit resurs ideal p24 bancomatpay blik giropay sepa verkkopankki mobilepay_subscriptions emv_token bcmc pp_blik_oc trustly eps estonia_banks latvia_banks lithuania_banks mb_way multibanco mybank payconiq paysafecard paysera postfinance satispay twint wechatpay santander offline_cash offline_bank_transfer offline_other

card

string

Reference to customer card if source type card

mps

string

Reference to MobilePay Subscriptions payment method if source type mobilepay_subscriptions

iban

string

IBAN number if source type sepa

fingerprint

string

Uniquely identifies this particular card number if credit card source

provider

string

Card acquirer or card payment gateway used if card source: reepay, aibms, bambora, barclays, clearhaus, cmcic, credibanco, cs, elavon, evry, first_data, handelsbanken, hsbc, nets, shift4, spreedly, swedbank, thailand_kbank, valitor, worldline, worldpay, test

reepay aibms bambora barclays clearhaus cmcic credibanco cs elavon evry first_data handelsbanken hsbc nets shift4 spreedly swedbank thailand_kbank valitor worldline worldpay test

frictionless

boolean

If the card transaction was exempted from a 3DS challenge

vipps_recurring

string

Reference to Vipps Recurring Subscriptions payment method if source type vipps_recurring

sepa_mandate

string

Reference to SEPA Mandate payment method if source type sepa

twint_mandate

string

Reference to Twint Mandate payment method if source type twint

paypal_mandate

string

Reference to PayPal Mandate payment method if source type paypal

offline_agreement_handle

string

Agreement handle if source type offline_cash, offline_bank_transfer, offline_other

offline_payment_instructions

string

Offline payment instructions if source type offline_cash, offline_bank_transfer, offline_other

auth_transaction

string

Reference to authorization transaction if charge is settled after authorization

card_type

string

Card type if credit card source: 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

Transaction card type if credit card source. Will differ from card_type if co-branded card. Transaction card type is the card type used for the transaction. 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

exp_date

string

Card expire date on form MM-YY if credit card source

masked_card

string

Masked card number if credit card source

card_country

string

Card issuing country if credit card source, in ISO 3166-1 alpha-2

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 charge has either been flagged or declined by a Frisbii Risk Filter rule. For flag action rules the charge can be successful, but may require special attention. For block action rules the decline error will be risk_filter_block.

acquirer_code

string

Card acquirer error code in case of card error

acquirer_message

string

Acquirer message in case of error

acquirer_reference

string

Card acquirer reference to transaction in case of card source. E.g. Nets order id or Clearhaus reference.

text_on_statement

string

Resulting text on bank statement if known

surcharge_fee

int32

Potential card surcharge fee added to amount if surcharging enabled

order_lines

array of objects

required

Order lines for charge

order_lines*

object

string

required

length ≥ 1

Per account unique order line id

ordertext

string

required

length ≥ 1

Order line text

amount

int32

required

Order line total amount including vat

vat

float

required

Order line vat percent

quantity

int32

required

≥ 1

Order line quantity

origin

string

required

Order line origin, one of the following: plan, add_on, ondemand, additional_cost, credit, discount, setup_fee, surcharge_fee, metered_billing_product

plan add_on ondemand additional_cost credit discount setup_fee surcharge_fee metered_billing_product

timestamp

date-time

required

Timestamp from order line origin, in ISO-8601 extended offset date-time format.

discounted_amount

int32

Order line amount after potential discount has been deducted

amount_vat

int32

required

Order line total vat amount

amount_ex_vat

int32

required

Order line total amount without vat

unit_amount

int32

required

Order line unit amount including vat

unit_amount_vat

int32

required

Order line unit vat amount

unit_amount_ex_vat

int32

required

Order line unit amount without vat

amount_defined_incl_vat

boolean

required

Whether the amount was defined including VAT. E.g. plan amount defined including VAT.

applied_tax_rule

string

Tax rule applied for order line indicates who is liable to account for the VAT.

reverse_charge intra_community_digital_service

origin_handle

string

Handle for additional cost, credit, plan or subscription discount in the case one of those are the origin

period_from

date-time

The start of billing period if the order line is a plan order line for a specific billing period, in ISO-8601 extended offset date-time format.

period_to

date-time

The end of billing period if the order line is a plan order line for a specific billing period, in ISO-8601 extended offset date-time format.

discount_percentage

int32

The discount percentage for discount order lines that has a percentage discount

discounted_order_line

string

For discount order lines a reference to the order line for which the order line is a discount

refunded_amount

int32

required

Refunded amount

authorized_amount

int32

Authorized amount if authorization was performed. The maximum amount that can be settled.

error_state

string

Frisbii error state if failed: soft_declined, hard_declined or processing_error. Soft and hard declines indicate a card decline. A soft decline is possibly recoverable and a subsequent request with the same card may succeed. E.g. insufficient funds. A processing error indicates an error processing the card either at Frisbii, the acquirer, or between Frisbii and the acquirer.

soft_declined hard_declined processing_error

recurring_payment_method

string

Optional reference to recurring payment method created in conjunction with charging

billing_address

object

Optional billing address

company

string

Company name

vat

string

Company vat number

attention

string

Attention

address

string

Address line 1

address2

string

Address line 2

city

string

City

country

string

Country in ISO 3166-1 alpha-2

string

phone

string

Phone number

first_name

string

First name

last_name

string

Last name

postal_code

string

Postal code

state_or_province

string

State or province. Should be in country subdivision code defined in ISO 3166-2.

shipping_address

object

Optional shipping address

company

string

Company name

vat

string

Company vat number

attention

string

Attention

address

string

Address line 1

address2

string

Address line 2

city

string

City

country

string

Country in ISO 3166-1 alpha-2

string

phone

string

Phone number

first_name

string

First name

last_name

string

Last name

postal_code

string

Postal code

state_or_province

string

State or province. Should be in country subdivision code defined in ISO 3166-2.

payment_context

string

Payment context describing if the transaction is customer or merchant initiated, one of the following values: cit, mit, cit_cof

Language

Credentials

Basic

base64


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.reepay.com/v1/charge/handle \
3
     --header 'accept: application/json'


xxxxxxxxxx
102
}
1
{
2
  "handle": "order-0000213",
3
  "state": "authorized",
4
  "customer": "customer006",
5
  "amount": 10000,
6
  "currency": "DKK",
7
  "authorized": "2015-04-04T12:40:56.656Z",
8
  "settled": "2015-04-04T12:40:56.656Z",
9
  "cancelled": "2015-04-04T12:40:56.656Z",
10
  "created": "2015-04-04T12:40:56.656Z",
11
  "transaction": "dafba2016614418f969fa5697383e47c",
12
  "error": "credit_card_expired",
13
  "processing": false,
14
  "source": {
15
    "type": "card",
16
    "card": "ca_80437fbb75cc5ec47aee09ff160e9cb9",
17
    "mps": "ms_4f3b975246e6acb7f569297d67830d64",
18
    "iban": "DK9520000123456789",
19
    "fingerprint": "cst_64e8a26cc0e85bc3f5ce7c5b366b4096",
20
    "provider": "clearhaus",
21
    "frictionless": true,
22
    "vipps_recurring": "vr_4f3b975246e6acb7f569297d67830d64",
23
    "sepa_mandate": "sr_4f3b975246e6acb7f569297d67830d64",
24
    "twint_mandate": "tr_4f3b975246e6acb7f569297d67830d64",
25
    "paypal_mandate": "ppr_4f3b975246e6acb7f569297d67830d64",

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

422Invalid request, 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