Silverflow

https://docs.silverflow.com
Admin
Silverflow is a comprehensive payment processing API platform that enables developers to accept card...
Tokens:50,050
Snippets:570
Trust Score:8
Update:5 months ago
Show doc for...
Tokens:
Raw
### Example Distribution Object Response

Source: https://docs.silverflow.com/guides/distributing-reports

This is an example of the response received after successfully creating a distribution object. It contains the unique distributionKey.

```json
{
  "distributionKey": "dist_abc123xyz789",
  "type": "email",
  "targets": [
    {
      "address": "recipient@example.com"
    }
  ],
  "reference": "monthly-sales-report",
  "status": "active",
  "createdAt": "2023-01-01T12:00:00Z",
  "updatedAt": "2023-01-01T12:00:00Z"
}
```

--------------------------------

### Example Refund Response

Source: https://docs.silverflow.com/guides/charge-actions

This is an example of a successful refund response, detailing the refund amount and associated charge keys.

```json
{
   "type": "refund",
   "key": "act-1e1dA2fgs1YTUhlhyPOp",
   "chargeKey": "chg-1e1dAHhgstYTUhlphPzZ",
   "refundChargeKey": "chg-31gfUhdhPzZAHhgstYlp",
   "amount": {
     "value": 2000,
     "currency": "EUR"
   },
   "status": {
     "authorization": "approved"
   },
   "clearAfter": "string",
   "authorizationResponse": {
     "network": "visa",
     "responseCode": "00",
     "responseCodeDescription": "Approved"
   },
   "created": "string",
   "lastModified": "string",
   "version": 1

}
```

--------------------------------

### Example Pagination Response

Source: https://docs.silverflow.com/guides/pagination

This is an example of a paginated response for merchants. The `offsetToken` property is used to retrieve the next page of results.

```json
{
    "merchants": [
        { ... },
        { ... },
        { ... }
    ],
    "offsetToken": "Q29uZ3JhdHVsYXRpb25zISBZb3Ugc3VjY2Vzc2Z1bGx5IGJhc2U2NC1kZWNvZGVkIGEgdmFsdWUuIEtlZXAgZ29pbmcsIHlvdSdyZSBvbiBhIHJvbGwhIDsp"
}
```

--------------------------------

### Example Reversal Response

Source: https://docs.silverflow.com/guides/charge-actions

This is an example of a successful reversal response for a charge.

```json
{
    "type": "reversal",
    "key": "act-1e1dA2fgs1YTUhlhyPOp",
    "chargeKey": "chg-1e1dAHhgstYTUhlphPzZ",
    "reference": "MyRef",
    "replacementAmount": {
        "value": 2599,
        "currency": "EUR"
    },
    "status": {
        "authorization": "none"
    },
    "created": "2019-08-24T14:15:22Z",
    "lastModified": "2019-08-24T14:15:22Z",
    "version": 1
}
```

--------------------------------

### Example Cancel Response

Source: https://docs.silverflow.com/guides/charge-actions

This is an example of a successful cancellation response, which includes reversal details.

```json
{
  "type": "reversal",
  "key": "act-1e1dA2fgs1YTUhlhyPOp",
  "chargeKey": "chg-1e1dAHhgstYTUhlphPzZ",
  "reference": "MyRef",
  "replacementAmount": {
    "value": 2599,
    "currency": "EUR"
  },
  "status": {
    "authorization": "approved"
  },
  "authorizationResponse": {
    "network": "american-express",
    "responseCode": "00",
    "responseCodeDescription": "Approved"
  },
  "created": "string",
  "lastModified": "string",
  "version": 1
}
```

--------------------------------

### Retrieve Distribution Objects

Source: https://docs.silverflow.com/guides/distributing-reports

Use GET /v1/distributions to list all distribution objects or GET /v1/distributions/{distributionKey} with the specific key to retrieve a single object.

```http
GET /v1/distributions
GET /v1/distributions/{distributionKey}
```

--------------------------------

### AVS Request Example

Source: https://docs.silverflow.com/guides/authorization

Set `avs: true` and provide `billingAddress` to enable Address Verification Service.

```json
{
   ... 
   "avs": true,
   "billingAddress": {
      "countryCode": {
         "alpha3": "NLD"
         },
      "stateOrProvince": "NH",
      "city": "Amsterdam",
      "line1": "Langtown Road",
      "line2": "4200",
      "postalCode": "1234BC"
      }
   ... 
}
```

--------------------------------

### Example HTTP Request for 3DS Method Flow

Source: https://docs.silverflow.com/guides/3d-secure

This example demonstrates how to send the `threeDSMethodData` to the issuer's `threeDSMethodURL`. The request must use the POST method, with `application/x-www-form-urlencoded` content type, and the `threeDSMethodData` value must be base64url encoded.

```http
POST /3ds-method-url HTTP/1.1
Host: issuer-3ds-method-url.com
Content-Type: application/x-www-form-urlencoded

threeDSMethodData=eyJ0aHJlZURTU2VydmVyVHJhbnNJRCI6ImExYjJjM2Q0LWU1ZjYtNzgwMC0xMjM0L TU2Nzg5MGFiY2RlZiIsInRocmVlRFNNZXRob2ROb3RpZmljYXRpb25VUkwiOiJodHRwczovL3lvdXItbm90aWZpY2F0aW9uLXVybC5jb20vM2RzLW1ldGhvZC1jYWxsYmFjayJ9
```

--------------------------------

### Example HTTP Request with Basic Auth

Source: https://docs.silverflow.com/guides/authentication

An example of an HTTP request using the constructed Basic Authentication header. Ensure your API key's 'key' and 'secret' are correctly Base64 encoded and formatted.

```http
GET /merchants HTTP/1.1
Host: api.silverflow.com
Authorization: Basic YXNrLWV5V3J4bmlJc1Bzc1NCTFdwcjpFV25rT09IQWpZc0p6S1dXRVdPQ2o3SlhTRVBHSlE=
```

--------------------------------

### Agent Activation Response

Source: https://docs.silverflow.com/guides/getting-started

Example response upon successful agent activation, containing the API management key and other details.

```json
{
    "key": "apk-1yBukhaXXmmqgpb3X07l",
    "status": "active",
    "agentKey": "cgt-1yuI4a3J1HIDldBmhoHt",
    "description": "API Key Management Key (created by Agent activation)",
    "permissions": [
        "all:All"
    ],
    "secret": "exampleY3DDMKzOk1dc4nBVtrqqdJfMk7xxbDgIgdLmyUhG4s6MT9VdyvsajaKis",
    "created": "2021-07-07T08:55:45.051Z",
    "version": 1
}
```

--------------------------------

### Example 3DS Method Notification Response

Source: https://docs.silverflow.com/guides/3d-secure

This is an example of the response structure received at the `threeDSMethodNotificationURL` upon completion of the 3DS Method flow. It echoes back the `threeDSServerTransID` provided earlier.

```json
{
  "threeDSServerTransID": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}
```

--------------------------------

### Example Refund Request

Source: https://docs.silverflow.com/guides/charge-actions

Use this request to refund a charge. It supports full or partial refunds and can optionally create a new charge for the refund.

```http
POST /charges/:chargeKey/refund

{
    "refundAmount": 2000,
    "clearAfter": "string",
    "createRefundCharge": true,
    "clearingMode": "auto",
}
```

--------------------------------

### Example Cancel Request

Source: https://docs.silverflow.com/guides/charge-actions

Use this request to cancel a charge. Ensure the charge was created with `clearingMode` = `auto` and has not yet been cleared.

```http
POST /charges/:chargeKey/cancel

{
  "reference": "MyRef"
}
```

--------------------------------

### AVS Response Example

Source: https://docs.silverflow.com/guides/authorization

AVS results are returned in `authentication.avs` and raw network codes in `authorizationIsoFields.networkSpecificFields`.

```json
{
  ...
  "authentication": {
    ...
    "cvc": "none",
    "avs": "match"
  },
  "authorizationIsoFields": {
     ...
    "networkSpecificFields": {
      "transactionIdentifier": "262649890621030",
      "cvv2ResultCode": "C",
      "avsResultCode": "Y"
    }
  },
...
```

--------------------------------

### Example HTTP POST Request for CReq

Source: https://docs.silverflow.com/guides/3d-secure

This example demonstrates how to send the Challenge Request (CReq) to the issuer's ACS URL. The CReq JSON must be base64url encoded and sent as the `creq` form parameter. The `Content-Type` header must be `application/x-www-form-urlencoded`.

```http
POST /challenge HTTP/1.1
Host: acsUrl.com
Content-Type: application/x-www-form-urlencoded

creq=eyJ0aHJlZURTU2VydmVyVHJhbnNJRCI6Ijg5ODg3MTQyLThmNTEtNDE0NC05MTFjLTEyMzQ1Njc4OTBhYiIsImFj nasılTransIDIjoiZjg4ODcxNDItN2Y1MS00MTQ0LTkxMWMtYWJjZGVmZ2hpamtsIiwibWVzc2FnZVR5cGUiOiJjUmVxIiwibWVzc2FnZ1ZlcnNpb24iOiIyLjEuMCIsImNoYWxsZW5nZVdpbmRvd1NpemUiOiIwNSJ9&threeDSSessionData=eyJ1c2VySWQiOiIxMjM0NSIsInNlc3Npb25JZCI6IjU0MzIxIn0=
```

--------------------------------

### Partial Approval Request Example

Source: https://docs.silverflow.com/guides/authorization

Set `allowPartialApproval: true` in the `POST /charges` request to enable partial approval for Visa & Mastercard.

```json
{
  "allowPartialApproval": true
}
```

--------------------------------

### Example 3DS Method Data Structure

Source: https://docs.silverflow.com/guides/3d-secure

This JSON object contains the data required for the 3DS Method flow. Ensure `threeDSServerTransID` is obtained from the `/3ds/cardRanges` response and `threeDSMethodNotificationURL` is a valid URL for receiving completion notifications.

```json
{
  "threeDSServerTransID": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "threeDSMethodNotificationURL": "https://your-notification-url.com/3ds-method-callback"
}
```

--------------------------------

### Create Merchant with Acceptor Template

Source: https://docs.silverflow.com/guides/getting-started

Use this endpoint to create a new merchant and define its initial acceptor configurations in a single request. The `merchantAcceptorTemplate` allows for creating one or more acceptors based on provided `binKey`s.

```json
POST /merchants

{
    "name": "sbx demo merchant",
    "legalName": "sbx demo BV",
    "registeredAddress": {
        "countryCode": {
            "alpha3": "NLD"
         },
         "stateOrProvince": "NH",
         "city": "Amsterdam",
         "line1": "Keizersgracht",
         "line2": "123",
         "postalCode": "1234"
    },
    "customerInquiry": "+3201234",
    "websiteUrl": "https://acme.com/catalog",
    "merchantAcceptorTemplate": {
        "mcc": "5816",
        "description": "sbx merchant mp2",
        "mid": "sbxmid2",
        "doingBusinessAsName": "sbxdba2",
        "webshopUrl": "https://webshop.test-merchant2.nl",
        "binKeys": [
            "bin-27HfmXzxd4oWMgBuzKo5",
            "bin-d4hHwxZsK6o4WmDsT70c"
        ]
     }
}
```

--------------------------------

### Get a Processor Token

Source: https://docs.silverflow.com/guides/card-tokenization

Fetch the metadata associated with a stored `processorTokenKey` by performing a GET request to the `/processorTokens` endpoint, using the key as a path parameter.

```APIDOC
## Get a Processor Token

### Description
Retrieves card metadata linked to a `processorTokenKey` via a GET request.

### Method
GET

### Endpoint
/processorTokens/{processorTokenKey}

### Parameters
#### Path Parameters
- **processorTokenKey** (string) - Required - The unique key of the processor token to retrieve.

### Response
#### Success Response (200)
- **key** (string) - The processor token key.
- **agentKey** (string) - The agent key associated with the token.
- **last4** (string) - The last four digits of the card number.
- **status** (string) - The current status of the token (e.g., 'active').
- **reference** (string) - A reference identifier for the token.
- **cardInfo** (array) - Details about the card.
- **created** (string) - The timestamp when the token was created.
- **cvcPresent** (boolean) - Indicates if the CVC was present when the token was last used or created.
- **version** (integer) - The version of the token entity.

#### Response Example
```json
{
   "key": "crd-1e1dA2fgs1YTUhlhyPOp",
   "agentKey": "cgt-1hPdFhmgaBzMS85d4QcG",
   "last4": "4444",
   "status": "active",
   "reference": "VEQNS4L35E6IU1TN",
   "cardInfo": [{...}],
   "created": "2023-08-14T12:23:43.014Z",
   "cvcPresent": true,
   "version": 1
}
```
```

--------------------------------

### Example HTTP Request with Bearer Token

Source: https://docs.silverflow.com/guides/authentication

An example of an HTTP request using a Bearer token for authentication. The token, typically a JWT, is placed directly in the Authorization header.

```http
GET /merchants HTTP/1.1
Host: api.silverflow.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
```

--------------------------------

### Retrieve Distribution Objects

Source: https://docs.silverflow.com/guides/distributing-reports

Retrieve existing distribution objects using the GET /v1/distributions endpoint to list all objects or GET /v1/distributions/{distributionKey} to retrieve a specific object by its key.

```APIDOC
## GET /v1/distributions

### Description
Retrieves a list of all distribution objects.

### Method
GET

### Endpoint
/v1/distributions

## GET /v1/distributions/{distributionKey}

### Description
Retrieves a specific distribution object by its key.

### Method
GET

### Endpoint
/v1/distributions/{distributionKey}
```

--------------------------------

### Get Reconciliation Details

Source: https://docs.silverflow.com/guides/getting-started

Call the Get Reconciliation Details endpoint with `from` and `to` timestamps to retrieve charge reconciliation data. The response includes an offset token for pagination and a list of reconciliation items.

```http
GET /reports/reconciliationDetails
```

```json
{
    "offsetToken": "eyJjcmVhdGVkIjoiMjAyMy0wNC0xM1QxMDoxNjoyNC44NzNaIiwiZW50aXR5IjoiZmlyc3RQcmVzZW50bWVudCNmYWxzZSNkbXMjMSIsImlkIjoidmlzYS0yMTIzNDU4MzEwMzM2MDAwMDAxMzUyNyIsImFnZW50S2V5IjoiY2d0LTFKTDMyR2hoM2tHWXNhNzRXYnFqIn0",
    "moreItems": true,
    "items": [
    {
        "key": "rcl-6r6yyukhjuy2t7ghafej",
        "groupReference": "mastercard-02708273027680000003485",
        "type": "firstPresentment-dms",
        "created": "2023-03-23T12:53:08.666Z",
        "entry": 1,
        "isCorrection": false,
        "reportingFor": "123456",
        "network": "mastercard",
        "fundsTransferDate": "2023-01-30",
        "fundsTransferBookDate": "2023-01-30",
        "networkFundsTransferKey": "nft-aTrKhISSAKrbPeEMHJQ5",
        "netSettlementAmount": {
            "value": 3498.473,
            "currency": "EUR",
            "impact": "credit"
        },
        "settlementService": {
            "code": "EU00000008",
            "id": "EU00000008-EUR",
            "name": "EUR - Deutsche Bank, Frankfurt",
            "cutOffTime": "2023-01-27T12:00:00.000Z"
        },
        "typeSpecific": {
            "arn": "mastercard-72802773027680000003485",
            "processingDate": "2023-01-30",
            "bin": {},
            "transactionReference": "abc1",
            "actionKey": "act-123gjkjg7t7t87",
            "actionReference": "actionRef766rjh",
            "clearableTime": "2023-01-30T05:58:32.598Z",
            "filename": "123456-230130-00016",
            "merchantAcceptor": {},
            "chargeKey": "chg-91f8a4wtasnd623tpehj",
            "authorizationAmount": {},
            "clearingAmount": {},
            "grossSettlementAmount": {},
            "interchangeFeeAmount": {},
            "acquirerIdCode": "123456",
            "transactionType": "purchase",
            "tags": {},
            "cardInfoSummary": {}
          }
        }
    ]
}
```

--------------------------------

### Process Charges with Merchant Key and Route

Source: https://docs.silverflow.com/guides/merchant-onboarding

Use this method to process charges by specifying the merchant key and an optional route. This ensures charges are routed to the correct network and BIN.

```json
{
  "merchantKey": "merchant-key-id",
  "route": "route-id"
}
```

--------------------------------

### Get a Processor Token

Source: https://docs.silverflow.com/guides/card-tokenization

Fetch card metadata linked to a processorTokenKey by performing a GET request on the \/processorTokens endpoint with the key as a path parameter. The response includes details like last4 digits, status, and CVC presence.

```json
{
   "key": "crd-1e1dA2fgs1YTUhlhyPOp",
   "agentKey": "cgt-1hPdFhmgaBzMS85d4QcG",
   "last4": "4444",
   "status": "active",
   "reference": "VEQNS4L35E6IU1TN",
   "cardInfo": [{...}],
   "created": "2023-08-14T12:23:43.014Z",
   "cvcPresent": true,
   "version": 1
}
```

--------------------------------

### Create API Key

Source: https://docs.silverflow.com/guides/getting-started

Creates new API keys with specified permissions and IP restrictions, using the API management key obtained from agent activation.

```APIDOC
## POST /apiKeys

### Description
Creates new API keys for integration purposes. These keys can be used to call various endpoints on the Silverflow API. Requires an API management key for authorization.

### Method
POST

### Endpoint
/apiKeys

### Parameters
#### Request Body
- **status** (string) - Required - The status of the API key (e.g., "active").
- **description** (string) - Optional - A description for the API key.
- **permissions** (array of strings) - Required - A list of permissions for the API key (e.g., ["all:All"]).
- **ipRanges** (array of strings) - Optional - A list of IP address ranges allowed to use this key.

### Request Example
```json
{
    "status": "active",
    "description": "IP-restricted key",
    "permissions": [
        "all:All"
    ],
    "ipRanges": [
         "185.184.111.39/32",
         "102.177.115.120/29",
         "0.0.0.0/0"
    ]
}
```
```

--------------------------------

### Create a Network Token

Source: https://docs.silverflow.com/guides/networktokenization

Submit card data to create network tokens. This is an asynchronous, bulk process. Providing CVC is optional but recommended. A PAN can only be tokenized once per merchant.

```bash
POST /networkTokens

{
   "enrollmentKey": "enr-25os7SQOxkKeQwUKYXIG",
   "type": "network",
   "cardData": {
      "number": "1234123412341234",
      "expiryMonth": 1,
      "expiryYear": 2020,
      "cvc": "123"
      }
}
```

--------------------------------

### Create a Distribution Object

Source: https://docs.silverflow.com/guides/distributing-reports

Use the POST /v1/distributions endpoint to create a distribution object. Specify the distribution type and target locations. The response includes a distributionKey needed for report schedules.

```json
{
  "type": "email",
  "targets": [
    {
      "address": "recipient@example.com"
    }
  ],
  "reference": "monthly-sales-report"
}
```

--------------------------------

### Dynamic Descriptor Request Example

Source: https://docs.silverflow.com/guides/authorization

Use the `dynamicDescriptor` field to customize merchant name and city for transactions.

```json
{
  "dynamicDescriptor": {
    "merchantName": "Example Merchant",
    "merchantCity": "Example City"
  }
}
```

--------------------------------

### Process Charges with Merchant Acceptor Key

Source: https://docs.silverflow.com/guides/merchant-onboarding

Use this method to process charges when the merchant acceptor is identified by its key. Ensure the `merchantAcceptorKey` is provided.

```json
{
  "merchantAcceptorKey": "merchant-acceptor-key-id"
}
```

--------------------------------

### Create SCOF Enrollment Request

Source: https://docs.silverflow.com/guides/merchant-enrollment

Use this endpoint to initiate the enrollment process for Mastercard SCOF. Ensure the provided merchant information is accurate, as updates with card networks are manual. The enrollment is an asynchronous batch process that may take up to 5 minutes.

```json
POST /enrollments

{
  "merchantKey": "mct-123dinkqFqfq3q2f2adfa",
  "type": "scof",
  "mid": "123456",
  "binKey": "bin-1iXRhbDjrT2Yxvo0mSZN",
  "programType": "merchant_obo",
  "programName": "string",
  "mccs": ["5621"]
}
```

--------------------------------

### Get Report Status

Source: https://docs.silverflow.com/guides/reporting

Retrieves the current status of a report generation process using its unique key.

```APIDOC
## GET reports/{Key}

### Description
Retrieves the status of a report using its unique key.

### Method
GET

### Endpoint
/reports/{Key}

### Parameters
#### Path Parameters
- **Key** (string) - Required - The unique key of the report.

### Response
#### Success Response (200)
- **status** (string) - The current status of the report (e.g., Pending, Completed, Failed).

#### Response Example
```json
{
  "status": "Completed"
}
```
```

--------------------------------

### Create a Processor Token

Source: https://docs.silverflow.com/guides/card-tokenization

Obtain a `processorTokenKey` by posting the required card data to the `/processorTokens` endpoint. The CVC is optional and can be provided here or in subsequent transaction endpoints.

```APIDOC
## Create a Processor Token

### Description
Posts card data to the `/processorTokens` endpoint to obtain a `processorTokenKey` for secure storage.

### Method
POST

### Endpoint
/processorTokens

### Request Body
- **number** (string) - Required - The primary account number (PAN) of the card.
- **expiryMonth** (integer) - Required - The expiration month of the card (1-12).
- **expiryYear** (integer) - Required - The expiration year of the card.
- **cvc** (string) - Optional - The Card Verification Value (CVV/CVC) of the card.

### Request Example
```json
{
   "number": "1111222233334444",
   "expiryMonth": 1,
   "expiryYear": 2047,
   "cvc": "123"
}
```

### Response
#### Success Response (200)
- **processorTokenKey** (string) - The unique key representing the tokenized card.
- **cardInfo** (array) - Information about the card, such as brand and co-branding status.
- **cvcPresent** (boolean) - Indicates if the CVC was provided in the request.

#### Response Example
```json
{
  "processorTokenKey": "ptk_examplekey123",
  "cardInfo": [{"brand": "Visa", "coBrand": ""}],
  "cvcPresent": true
}
```
```
Tokens:
Raw