Resume a payment

curl --request POST \
  --url https://api.sandbox.primer.io/payments/{id}/resume \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-API-VERSION: <x-api-version>' \
  --data '
{
  "resumeToken": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.sandbox.primer.io/payments/{id}/resume"

payload = { "resumeToken": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {
    "X-API-VERSION": "<x-api-version>",
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-API-VERSION': '<x-api-version>',
    'X-API-KEY': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({resumeToken: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};

fetch('https://api.sandbox.primer.io/payments/{id}/resume', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.primer.io/payments/{id}/resume",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'resumeToken' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>",
    "X-API-VERSION: <x-api-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.primer.io/payments/{id}/resume"

	payload := strings.NewReader("{\n  \"resumeToken\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-VERSION", "<x-api-version>")
	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.primer.io/payments/{id}/resume")
  .header("X-API-VERSION", "<x-api-version>")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"resumeToken\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.primer.io/payments/{id}/resume")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-VERSION"] = '<x-api-version>'
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"resumeToken\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "kHdEw9EG",
  "date": "2021-02-21T15:36:16.367687",
  "dateUpdated": "2021-02-21T15:36:17.133701",
  "status": "AUTHORIZED",
  "orderId": "order-abc",
  "customerId": "customer-123",
  "currencyCode": "EUR",
  "amount": 42,
  "cardTokenType": "CARD_PAN",
  "paymentMethod": {
    "paymentType": "SUBSCRIPTION",
    "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4",
    "isVaulted": true,
    "authorizationType": "FINAL",
    "descriptor": "Purchase: Socks",
    "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo",
    "paymentMethodType": "PAYMENT_CARD",
    "paymentMethodData": {
      "first6Digits": "411111",
      "firstDigits": "41111111",
      "last4Digits": "1111",
      "expirationMonth": "12",
      "expirationYear": "2030",
      "cardholderName": "John Biggins",
      "network": "Visa",
      "isNetworkTokenized": false,
      "binData": {
        "network": "VISA",
        "regionalRestriction": "UNKNOWN",
        "accountNumberType": "UNKNOWN",
        "accountFundingType": "UNKNOWN",
        "prepaidReloadableIndicator": "NOT_APPLICABLE",
        "productUsageType": "UNKNOWN",
        "productCode": "VISA",
        "productName": "VISA"
      }
    }
  },
  "processor": {
    "name": "STRIPE",
    "processorMerchantId": "acct_stripe_1234",
    "amountCaptured": 0,
    "amountRefunded": 0
  },
  "transactions": [
    {
      "type": "SALE",
      "processorStatus": "AUTHORIZED",
      "processorName": "STRIPE",
      "processorMerchantId": "acct_stripe_1234",
      "processorTransactionId": "54c4eb5b3ef8a",
      "authorizationCode": "831000",
      "cardTokenType": "CARD_PAN"
    }
  ],
  "customer": {
    "email": "customer123@gmail.com"
  },
  "metadata": {
    "productId": 123,
    "merchantId": "a13bsd62s"
  },
  "riskData": {
    "fraudChecks": {
      "source": "FRAUD_PROVIDER",
      "preAuthorizationResult": "THREE_DS",
      "postAuthorizationResult": "ACCEPT"
    },
    "cvvCheck": {
      "source": "PROCESSOR",
      "result": "MATCHED"
    },
    "avsCheck": {
      "source": "PROCESSOR",
      "result": {
        "streetAddress": "NOT_MATCHED",
        "postalCode": "NOT_VERIFIED",
        "responses": null
      }
    }
  }
}

{
  "error": {
    "description": "The payment was not processed in time. Processing will continue asynchronously.",
    "diagnosticsId": "1234567898",
    "errorId": "NoActionsToHandle",
    "recoverySuggestion": "Use GET /payments/:paymentId to get the state of the payment"
  }
}

{
  "error": {
    "errorId": "PaymentError",
    "description": "The payment could not be found",
    "diagnosticsId": "1234567898"
  }
}

POST

payments

{id}

resume

Resume a payment

curl --request POST \
  --url https://api.sandbox.primer.io/payments/{id}/resume \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-API-VERSION: <x-api-version>' \
  --data '
{
  "resumeToken": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.sandbox.primer.io/payments/{id}/resume"

payload = { "resumeToken": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {
    "X-API-VERSION": "<x-api-version>",
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-API-VERSION': '<x-api-version>',
    'X-API-KEY': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({resumeToken: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};

fetch('https://api.sandbox.primer.io/payments/{id}/resume', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.primer.io/payments/{id}/resume",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'resumeToken' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>",
    "X-API-VERSION: <x-api-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.primer.io/payments/{id}/resume"

	payload := strings.NewReader("{\n  \"resumeToken\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-VERSION", "<x-api-version>")
	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.primer.io/payments/{id}/resume")
  .header("X-API-VERSION", "<x-api-version>")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"resumeToken\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.primer.io/payments/{id}/resume")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-VERSION"] = '<x-api-version>'
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"resumeToken\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "kHdEw9EG",
  "date": "2021-02-21T15:36:16.367687",
  "dateUpdated": "2021-02-21T15:36:17.133701",
  "status": "AUTHORIZED",
  "orderId": "order-abc",
  "customerId": "customer-123",
  "currencyCode": "EUR",
  "amount": 42,
  "cardTokenType": "CARD_PAN",
  "paymentMethod": {
    "paymentType": "SUBSCRIPTION",
    "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4",
    "isVaulted": true,
    "authorizationType": "FINAL",
    "descriptor": "Purchase: Socks",
    "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo",
    "paymentMethodType": "PAYMENT_CARD",
    "paymentMethodData": {
      "first6Digits": "411111",
      "firstDigits": "41111111",
      "last4Digits": "1111",
      "expirationMonth": "12",
      "expirationYear": "2030",
      "cardholderName": "John Biggins",
      "network": "Visa",
      "isNetworkTokenized": false,
      "binData": {
        "network": "VISA",
        "regionalRestriction": "UNKNOWN",
        "accountNumberType": "UNKNOWN",
        "accountFundingType": "UNKNOWN",
        "prepaidReloadableIndicator": "NOT_APPLICABLE",
        "productUsageType": "UNKNOWN",
        "productCode": "VISA",
        "productName": "VISA"
      }
    }
  },
  "processor": {
    "name": "STRIPE",
    "processorMerchantId": "acct_stripe_1234",
    "amountCaptured": 0,
    "amountRefunded": 0
  },
  "transactions": [
    {
      "type": "SALE",
      "processorStatus": "AUTHORIZED",
      "processorName": "STRIPE",
      "processorMerchantId": "acct_stripe_1234",
      "processorTransactionId": "54c4eb5b3ef8a",
      "authorizationCode": "831000",
      "cardTokenType": "CARD_PAN"
    }
  ],
  "customer": {
    "email": "customer123@gmail.com"
  },
  "metadata": {
    "productId": 123,
    "merchantId": "a13bsd62s"
  },
  "riskData": {
    "fraudChecks": {
      "source": "FRAUD_PROVIDER",
      "preAuthorizationResult": "THREE_DS",
      "postAuthorizationResult": "ACCEPT"
    },
    "cvvCheck": {
      "source": "PROCESSOR",
      "result": "MATCHED"
    },
    "avsCheck": {
      "source": "PROCESSOR",
      "result": {
        "streetAddress": "NOT_MATCHED",
        "postalCode": "NOT_VERIFIED",
        "responses": null
      }
    }
  }
}

{
  "error": {
    "description": "The payment was not processed in time. Processing will continue asynchronously.",
    "diagnosticsId": "1234567898",
    "errorId": "NoActionsToHandle",
    "recoverySuggestion": "Use GET /payments/:paymentId to get the state of the payment"
  }
}

{
  "error": {
    "errorId": "PaymentError",
    "description": "The payment could not be found",
    "diagnosticsId": "1234567898"
  }
}

Authorizations

X-API-KEY

string

header

required

Headers

X-API-VERSION

string

required

Specifies the version of the API to use. This must be set to 2.4.

Example:

"2.4"

Path Parameters

string

required

ID of payment to resume.

Body

application/json

resumeToken

string<uuid>

required

A token containing any information that is sent back from the checkout to complete a blocked payment flow.

Response

Successful Response

string

required

The unique payment ID.

You can use this ID to retrieve the payment details, or perform downstream operations.

date

string<date-time>

required

The date and time at which the payment was created in UTC format.

dateUpdated

string<date-time>

required

The date and time of the last payment update in UTC format.

status

enum<string>

required

See the payment status table for more information.

Available options:

PENDING,

FAILED,

AUTHORIZED,

SETTLING,

PARTIALLY_SETTLED,

SETTLED,

DECLINED,

CANCELLED

orderId

string

required

Your reference for the payment.

Maximum string length: 255

currencyCode

enum<string>

required

The 3-letter currency code in ISO 4217 format. e.g. use USD for US dollars.

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BOV,

BRL,

BSD,

BTN,

BWP,

BYR,

BYN,

BZD,

CAD,

CDF,

CHE,

CHF,

CHW,

CLP,

CNY,

COP,

COU,

CRC,

CUC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ERN,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MAD,

MDL,

MKD,

MMK,

MNT,

MOP,

MRO,

MUR,

MVR,

MWK,

MXN,

MXV,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SOS,

SRD,

SSP,

SVC,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VND,

VUV,

WST,

XAF,

XAG,

XAU,

XBA,

XBB,

XBC,

XBD,

XCD,

XDR,

XFU,

XOF,

XPD,

XPF,

XPT,

XSU,

XTS,

XUA,

YER,

ZAR,

ZMW,

ZWL

amount

integer<int64>

required

The amount you charged the customer, in minor units.

Required range: x >= 0

paymentMethod

Payment Method Options · object

required

The payment method options provided in the request, as well as the token used to process the payment.

Show child attributes

transactions

TransactionOverviewAPISchema · object[]

required

A list summarizing the transactions that occurred while processing the payment.

Note: a refund is a separate transaction and so will appear in this transactions list if a refund was performed.

Show child attributes

cardTokenType

enum<string>

The type of card token used for the payment.

Only applies for card payments.

Available options:

CARD_PAN,

NETWORK_TOKEN,

PROCESSOR_TOKEN

Example:

"CARD_PAN"

order

Order Details · object

More information associated with the order.

Show child attributes

customerId

string

The unique identifier for your customer.

Maximum string length: 255

customer

Customer Details · object

More information associated with the customer.

Show child attributes

metadata

Payment Metadata · object

Additional data to be used throughout the payment lifecycle.

processor

Processor Information · object

More information associated with the payment processor, including the processor name.

Show child attributes

requiredAction

Required action · object

Required action to perform in order to resume the payment workflow. This can be requiring a 3DS check from the customer for instance.

Show child attributes

statusReason

Status Reason · object

Check this field for more information regarding the payment's status. This is especially useful when the status is DECLINED or FAILED.

Show child attributes

riskData

Risk Data · object

Risk data associated with this payment.

Show child attributes