3.42. /api/scoring/v1/score

Introduction

Card scoring request is initiated through HTTPS POST ( with UTF-8 encoding ) request to the URLs and the parameters specified below. Use OAuth HMAC-SHA1 for authentication.

API URLs

Integration

Production

https://sandbox.payneteasy.com/paynet/api/scoring/v1/score/{endpoint_id}

https://gate.payneteasy.com/paynet/api/scoring/v1/score/{endpoint_id}

Request Parameters

Note

Request must have content-type=application/x-www-form-urlencoded and Authorization headers.

Parameter name

Description

Format

card-ref-id

The card-ref-id created earlier using create-card-ref call that can be used to find the specific card that is needed. To create create-card-ref see /api/v2/create-card-ref/. Send either card-ref-id or card-number, not all.

N{1-*}

card-number

Full card number. Send either card-number or card-ref-id, not all.

N{13-19}

client-order-id

Unique order identifier assigned by Connecting Party.

N{1-*}

first-name

First Name.

N{64}

last-name

Last Name.

N{64}

middle-name

Middle Name.

N{64}

birth-date

Customer’s birth date.

1982-07-31

rating

For example 0000.

N{4}

phone

Customer’s full international phone number, including country code.

N{11}

Response Parameters

Parameter name

Description

type

The type of response. May be async-response, validation-error, error. If type equals validation-error or error, error-message and error-code parameters contain error details.

paynet-order-id

Order id assigned to the order by Payneteasy.

merchant-order-id

Connecting Party order id

serial-number

Unique number assigned by Payneteasy server to particular request from the Connecting Party.

error-message

If status is error this parameter contains the reason for decline or error details.

error-code

The error code is case of error status.

Request example

POST /paynet/api/scoring/v1/score/2404
Parameters:
   birth-date: 2000-01-01
   card-ref-id: 12345
   client-order-id: score123
   create-card-ref: false
   first-name: John
   last-name: Smith
   middle-name: M
   phone: 19019019191
   rating: 5
Headers:
   accept: */*
   accept-encoding: gzip,deflate
   authorization: OAuth realm="",oauth_version="1.0",oauth_consumer_key="connectingparty",oauth_timestamp="1702073235",oauth_nonce="OPASWJfawifJHG",oauth_signature_method="HMAC-SHA1", oauth_signature="8FpDccqJGDwppPUnLwokfJl53Mc%3D"
   content-length: 419
   content-type: application/x-www-form-urlencoded

Success Response Example

HTTP/2 200 OK
Date: Mon, 01 Dec 2020 11:47:18 GMT

type=async-response
&serial-number=00000000-0000-0000-0000-00010b87db96
&merchant-order-id=score123
&paynet-order-id=9550
&end-point-id=2404

Fail Response Example

HTTP/2 403 Forbidden
Date: Mon, 01 Dec 2020 11:47:18 GMT

type=error
&serial-number=00000000-0000-0000-0000-000003da9cb1
&error-message=Forbidden
&error-code=-1

Request Builder

HTTP method
URL
parameters
version
consumer key
consumer secret
timestamp

nonce

signature method

normalized parameters
signature base string
Signature
authorization header