Create a session for a payment service definition

Creates a session for a payment service that supports sessions.

POST /payment-service-definitions/{payment_service_definition_id}/sessions

C#

C#

using Gr4vy;
using Gr4vy.Models.Components;
using System.Collections.Generic;

var sdk = new Gr4vySDK(
    id: "example",
    server: SDKConfig.Server.Sandbox,
    bearerAuthSource: Auth.WithToken(privateKey),
    merchantAccountId: "default"
);

var res = await sdk.PaymentServiceDefinitions.SessionAsync(
    paymentServiceDefinitionId: "adyen-ideal",
    requestBody: new Dictionary<string, object>() {

    }
);

// handle response

200

{
  "status": "<string>",
  "type": "payment-service-session",
  "code": "UNKNOWN_ERROR",
  "status_code": 201,
  "response_body": {
    "sessionId": "12345"
  }
}

This endpoint requires the transactions.write scope.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

payment_service_definition_id · string · required

Example:

"adyen-ideal"

Body

application/json

The JSON payload to sent to the payment service's session API.

Response

200

application/json

Successful Response

The session data received from the payment service.

status · string · required

The status of the response.

Example:

"succeeded"

type · string · default: payment-service-session

Always payment-service-session.

Allowed value: "payment-service-session"

Example:

"payment-service-session"

code · string | null

A generic error code that may be returned when the session could not be generated.

Example:

"UNKNOWN_ERROR"

status_code · integer | null

The HTTP status code received from the payment service.

Example:

201

response_body · Response Body · object

The JSON response body received from the payment service.

Example:

{ "sessionId": "12345" }